Sample - GitHub REST API
POST/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values

Add issue field values to an issue

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."

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters · 1 body field
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
issue_numberintegerrequired
The number that identifies the issue.
issue_field_valuesarray<object>optional
An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.

6 status codes
200Response
issue_field_idintegerrequired
Unique identifier for the issue field.
issue_field_namestringoptional
The human-readable name of the issue field.
node_idstringrequired
data_typestringrequired
The data type of the issue field
Allowed:textsingle_selectmulti_selectnumberdate
valuestringrequired
The value of the issue field
single_select_optionobjectoptional
Details about the selected option (only present for single_select fields)
multi_select_optionsarray<object>optional
Details about the selected options
400Bad Request
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional
503Service unavailable
codestringoptional
messagestringoptional
documentation_urlstringoptional

Error handling

A 400 is returned: Bad Request. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed. A 503 is returned: Service unavailable.