Atlassian: Create custom field options (context)

← Issue custom field options operations · Get started

Operation atlassian.createcustomfieldoption

Provider route: POST /{cloudId}/rest/api/3/field/{fieldId}/context/{contextId}/option. 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["issueCustomFieldOptions"]["createCustomFieldOption"]>[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.issueCustomFieldOptions.createCustomFieldOption(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_custom_field_options.create_custom_field_option(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}$
path.fieldId	string	Required within parent
path.contextId	integer	Required within parent	Format: int64
body	Model	Required within parent	Expand Create custom field options (context) — request body — body

Referenced models: Create custom field options (context) — 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 custom field options (context) — response body

Referenced models: Create custom field options (context) — response body

Schemas

Create custom field options (context) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of the options to create for a custom field. write Only: true Additional keys: not allowed
options	array	Optional	Details of options to create.
options[]	Model	Each item	Expand Create custom field options (context) — request body — body options item

Referenced models: Create custom field options (context) — request body — body options item

Create custom field options (context) — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of custom field options for a context.
options	JSON	Optional
options (anyOf 1)	array	Alternative	The created custom field options.
options (anyOf 1)[]	Model	Each item	Expand Get custom field options (context) — response body — values The list of items item
options (anyOf 2)	null	Alternative

Referenced models: Get custom field options (context) — response body — values The list of items item

Create custom field options (context) — request body — body options item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a custom field option to create. Additional keys: not allowed
disabled	boolean	Optional	Whether the option is disabled.
optionId	string	Optional	For cascading options, the ID of a parent option.
value	string	Required within parent	The value of the custom field option.

Get custom field options (context) — response body — values The list of items item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the custom field options for a context.
disabled	JSON	Optional
disabled (anyOf 1)	boolean	Alternative	Whether the option is disabled.
disabled (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the custom field option.
id (anyOf 2)	null	Alternative
optionId	JSON	Optional
optionId (anyOf 1)	string	Alternative	For cascading options, the ID of the custom field option containing the cascading option.
optionId (anyOf 2)	null	Alternative
value	JSON	Optional
value (anyOf 1)	string	Alternative	The value of the custom field option.
value (anyOf 2)	null	Alternative

Policy, approvals and errors

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