Atlassian: Create priority

Atlassian issuePriorities.createPriority: arguments, response, policy and SDK examples.

← Issue priorities operations · Get started

Operation atlassian.createpriority

Provider route: POST /{cloudId}/rest/api/3/priority. 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["issuePriorities"]["createPriority"]>[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.issuePriorities.createPriority(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_priorities.create_priority(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 Create priority — request body — body

Referenced models: Create priority — 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 Create priority — response body

Referenced models: Create priority — response body

Schemas

Create priority — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of an issue priority. Additional keys: allowed
`avatarId`	integer	Optional	The ID for the avatar for the priority. Either the iconUrl or avatarId must be defined, but not both. This parameter is nullable and will become mandatory once the iconUrl parameter is deprecated. Format: int64 write Only: true
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the priority. Maximum length: 255 write Only: true
`description (anyOf 2)`	null	Alternative
`iconUrl`	JSON	Optional
`iconUrl (anyOf 1)`	string	Alternative	The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Either the iconUrl or avatarId must be defined, but not both. One of: /images/icons/priorities/blocker.png, /images/icons/priorities/critical.png, /images/icons/priorities/high.png, /images/icons/priorities/highest.png, /images/icons/priorities/low.png, /images/icons/priorities/lowest.png, /images/icons/priorities/major.png, /images/icons/priorities/medium.png, /images/icons/priorities/minor.png, /images/icons/priorities/trivial.png, /images/icons/priorities/blocker_new.png, /images/icons/priorities/critical_new.png, /images/icons/priorities/high_new.png, /images/icons/priorities/highest_new.png, /images/icons/priorities/low_new.png, /images/icons/priorities/lowest_new.png, /images/icons/priorities/major_new.png, /images/icons/priorities/medium_new.png, /images/icons/priorities/minor_new.png, /images/icons/priorities/trivial_new.png Maximum length: 255 write Only: true
`iconUrl (anyOf 2)`	null	Alternative
`name`	string	Required within parent	The name of the priority. Must be unique. Maximum length: 60 write Only: true
`statusColor`	string	Required within parent	The status color of the priority in 3-digit or 6-digit hexadecimal format. write Only: true

Create priority — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The ID of an issue priority. Additional keys: allowed
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the issue priority. Read only: true
`id (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.createpriority. Catalog operation: createpriority. 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: ["manage:jira-configuration"]

Official provider source

Report an issue with this page