Set issue field values for an issue
Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.
This endpoint supports the following field data types:
- text: String values for text fields
- single_select: Option names for single-select fields (must match an existing option name)
- number: Numeric values for number fields
- date: ISO 8601 date strings for date fields
This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.
Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
Path parameters
The account owner of the repository. The name is not case sensitive.
The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies the issue.
Request body
Example request
{
"issue_field_values": [
{
"field_id": 123
}
]
}Response
Response
Example response
[
{
"issue_field_id": 1,
"issue_field_name": "Priority",
"node_id": "IFT_GDKND",
"data_type": "text",
"value": "Sample text",
"single_select_option": {
"id": 1,
"name": "High",
"color": "red"
},
"multi_select_options": [
{
"id": 1,
"name": "High",
"color": "red"
}
]
}
]