Atlassian: Bulk edit issues

← Issue bulk operations operations · Get started

Operation atlassian.submitbulkedit

Provider route: POST /{cloudId}/rest/api/3/bulk/issues/fields. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issueBulkOperations"]["submitBulkEdit"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issueBulkOperations.submitBulkEdit(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issue_bulk_operations.submit_bulk_edit(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
body	Model	Required within parent	Expand Bulk edit issues — request body — body

Referenced models: Bulk edit issues — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Bulk edit issues — response body

Referenced models: Bulk edit issues — response body

Schemas

23 more schemas are linked from the tables above, on the schema pages.

Bulk edit issues — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Issue Bulk Edit Payload Additional keys: not allowed
editedFieldsInput	Model	Required within parent	Expand Bulk edit issues — request body — body edited Fields Input An object that defines the values to be updated in specified fields of an issue. The structure and content of this parameter vary depending on the type of field being edited. Although the order is not significant, ensure that field IDs align with those in selectedActions.
selectedActions	array	Required within parent	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). write Only: true
selectedActions[]	string	Each item	write Only: true
selectedIssueIdsOrKeys	array	Required within parent	List of issue IDs or keys which are to be bulk edited. These IDs or keys can be from different projects and issue types. write Only: true
selectedIssueIdsOrKeys[]	string	Each item	write Only: true
sendBulkNotification	JSON	Optional
sendBulkNotification (anyOf 1)	boolean	Alternative	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. Default: true write Only: true
sendBulkNotification (anyOf 2)	null	Alternative

Referenced models: Bulk edit issues — request body — body edited Fields Input

Bulk edit issues — response body

Field	Type	Presence	Description and constraints
$	object	Root
taskId	JSON	Optional
taskId (anyOf 1)	string	Alternative
taskId (anyOf 2)	null	Alternative

Bulk edit issues — request body — body edited Fields Input cascading Select Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
childOptionValue	Model	Optional	Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item option
fieldId	string	Required within parent
parentOptionValue	Model	Required within parent	Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item option

Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Fields item option

Bulk edit issues — request body — body edited Fields Input color Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
color	Model	Required within parent	Expand Bulk edit issues — request body — body edited Fields Input color Fields item color
fieldId	string	Required within parent

Referenced models: Bulk edit issues — request body — body edited Fields Input color Fields item color

Bulk edit issues — request body — body edited Fields Input date Picker Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
date	Model	Optional	Expand Bulk edit issues — request body — body edited Fields Input date Picker Fields item date
fieldId	string	Required within parent

Referenced models: Bulk edit issues — request body — body edited Fields Input date Picker Fields item date

Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
dateTime	Model	Required within parent	Expand Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item date Time
fieldId	string	Required within parent

Referenced models: Bulk edit issues — request body — body edited Fields Input date Time Picker Fields item date Time

Bulk edit issues — request body — body edited Fields Input original Estimate Field

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
originalEstimateField	string	Required within parent

Bulk edit issues — request body — body edited Fields Input issue Type

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
issueTypeId	string	Required within parent

Bulk edit issues — request body — body edited Fields Input labels Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
bulkEditMultiSelectFieldOption	string	Required within parent	One of: ADD, REMOVE, REPLACE, REMOVE_ALL
fieldId	string	Required within parent
labelProperties	array	Optional
labelProperties[]	Model	Each item	Expand Bulk edit issues — request body — body edited Fields Input labels Fields item label Properties item
labels	array	Required within parent
labels[]	Model	Each item	Expand Bulk edit issues — request body — body edited Fields Input color Fields item color

Referenced models: Bulk edit issues — request body — body edited Fields Input color Fields item color, Bulk edit issues — request body — body edited Fields Input labels Fields item label Properties item

Bulk edit issues — request body — body edited Fields Input multiselect Components

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
bulkEditMultiSelectFieldOption	string	Required within parent	One of: ADD, REMOVE, REPLACE, REMOVE_ALL
components	array	Required within parent
components[]	Model	Each item	Expand Bulk edit issues — request body — body edited Fields Input multiselect Components components item
fieldId	string	Required within parent

Referenced models: Bulk edit issues — request body — body edited Fields Input multiselect Components components item

Bulk edit issues — request body — body edited Fields Input multiple Group Picker Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fieldId	string	Required within parent
groups	array	Required within parent
groups[]	Model	Each item	Expand Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item group

Referenced models: Bulk edit issues — request body — body edited Fields Input single Group Picker Fields item group

Bulk edit issues — request body — body edited Fields Input multiple Select Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fieldId	string	Required within parent
options	array	Required within parent
options[]	Model	Each item	Expand Bulk edit issues — request body — body edited Fields Input single Select Fields item option

Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Fields item option

Bulk edit issues — request body — body edited Fields Input multiple Select Clearable User Picker Fields item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fieldId	string	Required within parent
users	array	Optional
users[]	Model	Each item	Expand Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item user

Referenced models: Bulk edit issues — request body — body edited Fields Input single Select Clearable User Picker Fields item user

Policy, approvals and errors

SDK function policy ID: atlassian.submitbulkedit. Catalog operation: submitbulkedit. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["write:jira-work"]

Official provider source