Atlassian: Save a custom project template

← Project templates operations · Get started

Operation atlassian.savetemplate

Provider route: POST /{cloudId}/rest/api/3/project-template/save-template. 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["projectTemplates"]["saveTemplate"]>[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.projectTemplates.saveTemplate(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.project_templates.save_template(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 Save a custom project template — request body — body

Referenced models: Save a custom project template — 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 Save a custom project template — response body

Referenced models: Save a custom project template — response body

Schemas

Save a custom project template — response body

Field	Type	Presence	Description and constraints
$	object	Root
projectTemplateKey	JSON	Optional
projectTemplateKey (anyOf 1)	Model	Alternative	Expand Gets a custom project template — response body — project Template Key key, uuid
projectTemplateKey (anyOf 2)	null	Alternative

Referenced models: Gets a custom project template — response body — project Template Key key, uuid

Save a custom project template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request to save a custom template Additional keys: not allowed
templateDescription	string	Optional	The description of the template Maximum length: 150
templateFromProjectRequest	Model	Optional	Expand Save a custom project template — request body — body template From Project Request
templateName	string	Optional	The name of the template Maximum length: 50

Referenced models: Save a custom project template — request body — body template From Project Request

Gets a custom project template — response body — project Template Key key, uuid

Field	Type	Presence	Description and constraints
$	object	Root
key	JSON	Optional
key (anyOf 1)	string	Alternative
key (anyOf 2)	null	Alternative
uuid	JSON	Optional
uuid (anyOf 1)	string	Alternative	Format: uuid
uuid (anyOf 2)	null	Alternative

Save a custom project template — request body — body template From Project Request

Field	Type	Presence	Description and constraints
$	object	Root	The request details to generate template from a project Additional keys: not allowed
projectId	integer	Optional	The ID of the target project Format: int64
templateGenerationOptions	Model	Optional	Expand Edit a custom project template — request body — body template Generation Options
templateType	string	Optional	The type of the template: LIVE | SNAPSHOT One of: LIVE, SNAPSHOT

Referenced models: Edit a custom project template — request body — body template Generation Options

Edit a custom project template — request body — body template Generation Options

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
enableScreenDelegatedAdminSupport	boolean	Optional	Enable screen delegated admin support for the template. This means screen and associated schemes will be copied rather than referenced.
enableWorkflowDelegatedAdminSupport	boolean	Optional	Enable workflow delegated admin support for the template. This means workflows and workflow schemes will be copied rather than referenced.

Policy, approvals and errors

SDK function policy ID: atlassian.savetemplate. Catalog operation: savetemplate. 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