Update custom field value

PUT

/rest/api/3/app/field/{fieldIdOrKey}/value

Updates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that created them.

Permissions required: Only the app that created the custom field can update its values with this operation.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/app/field//value' \
--header 'Content-Type: application/json' \
--data-raw '{
    "updates": [
        {
            "issueIds": [
                10010
            ],
            "value": "new value"
        }
    ]
}'

Response Example

204 - Example 1

null

Request

Path Params

fieldIdOrKey

string

required

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

Query Params

generateChangelog

string

optional

Whether to generate a changelog for this update.

Body Params application/json

Details of updates for a custom field.

updates

array[object (CustomFieldValueUpdate) {2}]

optional

The list of custom field update details.

issueIds

array[integer <int64>]

write-onlyrequired

The list of issue IDs.

value

required

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.

Examples

Responses

🟢204Returned if the request is successful.

application/json

Body

No schema defined

🟠400Returned if the request is invalid.

🟠403Returned if the request is not authenticated as the app that provided the field.

🟠404Returned if the field is not found.

Modified at 2023-07-13 03:27:27

Update custom fields

Get custom field configurations