YouTrack Server
 
2019.2
Get YouTrack Standalone
You are viewing the documentation for an earlier version of YouTrack Server. View this page in the current documentation
  1. Resources for Developers
  2. REST API
  3. REST API Use Cases
  4. Update a Text Field Value

Update a Text Field Value

Last modified: 17 December 2019

Use Case:

Use the REST API to update the value stored in a custom field with text type.

note

Please notice that this example is valid for YouTrack 2019.1 and later versions. In the previous versions, though the principle is the same, query parameters and entity attributes may differ. Also, a number of features, like addressing an entity by its name, were introduced in 2019.1 and are not supported in the previous versions.

Summary

Make a POST request to the following endpoint: /api/issues/{issueID}?[fields]

Step-by-Step

  1. To update a custom text field in an issue, send a POST request to the target issue. You can reference the issue by issue ID or issue entity ID.

  2. In the fields request parameter, specify the attributes of the returned entity that you want to get in response. For example, you can request the id and name of the target custom field along with its updated value.

  3. In the request body, pass a JSON with the name, $type, and value for the text field that you want to update.

    So, the final request is:

    curl -X POST 'https://example.myjetbrains.com/youtrack/api/issues/NP-98?fields=customFields(id,name,value(text))' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer perm:cm9vdA==.MjZGZWI=.WB02vjX0cM2ltLTJXUE3VOWHpJYYNx' \
-H 'Content-Type: application/json' \
-d '{"customFields":[{"name":"Customer","$type":"TextIssueCustomField","value":{"text":"Valued Customer"}}]}'

  4. To confirm that the target issue text field was set to the corresponding value, let's check the response from the server:

    {
    "customFields": [
        ...
        {
            "value": {
                "text": "Valued Customer",
                "$type": "TextFieldValue"
            },
            "name": "Customer",
            "id": "194-4",
            "$type": "TextIssueCustomField"
        }
    ],
    "$type": "Issue"
}