PUT /rest/api/2/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 and custom field types declared in their own manifests.

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.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`fieldIdOrKey`	String	Yes	The ID or key of the custom field. For example, `customfield_10010`.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`generateAppEvents`	Boolean	No	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. Default value: true
`generateChangelog`	Boolean	No	Whether to generate a changelog for this update. Default value: true

generateAppEvents

Boolean

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.

Default value: true

generateChangelog

Boolean

Whether to generate a changelog for this update.

Default value: true

Request body fields

Name Type Required Description

Name	Type	Required	Description
`updates[]`	Array	No	The list of custom field update details.
`updates[].issueIds[]`	Array	Yes	The list of issue IDs.
`updates[].value`		Yes	The value for the custom field. The value must be compatible with the custom field type as follows: `string` the value must be a string. `number` the value must be a number. `datetime` the value must be a string that represents a date in the ISO format or the simplified extended ISO format. For example, `"2023-01-18T12:00:00-03:00"` or `"2023-01-18T12:00:00.000Z"`. However, the milliseconds part is ignored. `user` the value must be an object that contains the `accountId` field. `group` the value must be an object that contains the group `name` or `groupId` field. Because group names can change, we recommend using `groupId`. A list of appropriate values must be provided if the field is of the `list` collection type.

updates[]

Array

The list of custom field update details.

updates[].issueIds[]

Array

Yes

The list of issue IDs.

updates[].value

Yes

The value for the custom field. The value must be compatible with the custom field type as follows:

string the value must be a string.
number the value must be a number.
datetime the value must be a string that represents a date in the ISO format or the simplified extended ISO format. For example, "2023-01-18T12:00:00-03:00" or "2023-01-18T12:00:00.000Z". However, the milliseconds part is ignored.
user the value must be an object that contains the accountId field.
group the value must be an object that contains the group name or groupId field. Because group names can change, we recommend using groupId.

A list of appropriate values must be provided if the field is of the list collection type.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.