issues

Add issue field values to an issue

Changed on

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. Adding an empty array will clear all existing field values for the issue.

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

Only users with push access to the repository can add 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."

post/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values
  • Auth: none declared

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

issue_numberinteger required

The number that identifies the issue.

Request body

Example request

{
  "issue_field_values": [
    {
      "field_id": 123
    }
  ]
}

Response

Response

issue_field_idinteger required

Unique identifier for the issue field.

issue_field_namestring

The human-readable name of the issue field.

node_idstring required
data_type'text' | 'single_select' | 'multi_select' | 'number' | 'date' required

The data type of the issue field

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"
      }
    ]
  }
]

Changes

  • 2022-11-2800a3fe4953d7Revision changes
    • info

      added the optional property / to the response with the status

  • 2022-11-2893714ad5c940Revision changes
    • warning

      added the new multi_select enum value to the / response property for the response status

    • info

      request property // list-of-types was widened by adding types array to media type application/json

    • info

      added the optional property / to the response with the status