Atlassian: Archive issue(s) by issue ID key
Atlassian issues.archiveIssues: arguments, response, policy and SDK examples.
← Issues operations · Get started
Operation atlassian.archiveissues
Provider route: PUT /{cloudId}/rest/api/3/issue/archive. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["issues"]["archiveIssues"]>[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.issues.archiveIssues(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.issues.archive_issues(arguments) result = await call.wait() return result.body_json()| 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 Archive issue(s) by issue ID key — request body — body |
Referenced models: Archive issue(s) by issue ID key — request body — body
Response
Section titled “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 Archive issue(s) by issue ID key — response body |
Referenced models: Archive issue(s) by issue ID key — response body
Schemas
Section titled “Schemas”Archive issue(s) by issue ID key — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of Issue Ids Or Keys that are to be archived or unarchived Additional keys: not allowed |
issueIdsOrKeys | array | Optional | |
issueIdsOrKeys[] | string | Each item |
Archive issue(s) by issue ID key — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Number of archived/unarchived issues and list of errors that occurred during the action, if any. |
errors | JSON | Optional | |
errors (anyOf 1) | Model | Alternative | Expand Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission |
errors (anyOf 2) | null | Alternative | |
numberOfIssuesUpdated | JSON | Optional | |
numberOfIssuesUpdated (anyOf 1) | JSON | Alternative | |
numberOfIssuesUpdated (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
numberOfIssuesUpdated (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
numberOfIssuesUpdated (anyOf 2) | null | Alternative |
Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission
Archive issue(s) by issue ID key — response body — errors issue Is Subtask, issues In Archived Projects, issues In Unlicensed Projects, issues Not Found, user Does Not Have Permission issue Is Subtask count, issue Ids Or Keys, message
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | JSON | Optional | |
count (anyOf 1) | JSON | Alternative | |
count (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
count (anyOf 2) | null | Alternative | |
issueIdsOrKeys | JSON | Optional | |
issueIdsOrKeys (anyOf 1) | array | Alternative | Unique items: true |
issueIdsOrKeys (anyOf 1)[] | string | Each item | |
issueIdsOrKeys (anyOf 2) | null | Alternative | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | |
message (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: atlassian.archiveissues. Catalog operation: archiveissues. 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"]