provider Issue custom field values (apps) PUT /rest/api/3/app/field/{fieldIdOrKey}/value
@utdk/jira /rest/api/3/app/field/{fieldIdOrKey}/value
Update custom field value
Updates the value of a custom field on one or more issues. Apps can only perform this operation on [custom fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) declared in their own manifests. **[Permissions](#permissions) required:** Only the app that owns the custom field or custom field type can update its values with this operation. The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
fieldIdOrKey path required
The ID or key of the custom field. For example, `customfield_10010`.
string
generateChangelog query
Whether to generate a changelog for this update.
boolean
generateAppEvents query
Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data.
boolean

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

updatecustomfieldvalue
PUT/rest/api/3/app/field/{fieldIdOrKey}/value
Updates the value of a custom field on one or more issues. Apps can only perform this operation on [custom fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) declared in their own manifests. **[Permissions](#permissions) required:** Only the app that owns the custom field or custom field type can update its values with this operation. The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

Parameters

required

The ID or key of the custom field. For example, `customfield_10010`.

Whether to generate a changelog for this update.

Whether to generate app events for this update. Suppresses Forge, Connect, OAuth 2.0, and admin-configured webhooks (registered via the Jira admin UI). Note: Suppressing events means that "issue updated" events will not be emitted for your app or any other apps installed in Jira. This may cause other apps to retain stale data for the updated field, resulting in potentially confusing behaviour. We do not recommend using this flag in a Marketplace app as it may result in incompatibilities with other apps that depend on up-to-date issue data.

Input

The list of custom field update details.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.updatecustomfieldvalue({
  "generateChangelog": true,
  "generateAppEvents": true
})