Skip to content
forgit api docs

Add issue field values to an issue

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

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

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

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

repo
required
string

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

issue_number
required
integer

The number that identifies the issue.

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
issue_field_values

An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.

Array<object>
<= 25 items
object
field_id
required

The ID of the issue field to set

integer
value
required
One of:

The value to set for text, single_select, or date fields

string
Examples

Add multiple field values 

{
  "issue_field_values": [
    {
      "field_id": 123,
      "value": "Critical"
    },
    {
      "field_id": 456,
      "value": 5
    },
    {
      "field_id": 789,
      "value": "2024-12-31"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json

The current issue field values for this issue after adding the new values

Array<object>
Issue Field Value

A value assigned to an issue field

object
issue_field_id
required

Unique identifier for the issue field.

integer format: int64
issue_field_name

The human-readable name of the issue field.

string
node_id
required
string
data_type
required

The data type of the issue field

string
Allowed values: text single_select multi_select number date
value
required
Any of:
string
single_select_option

Details about the selected option (only present for single_select fields)

object
id
required

Unique identifier for the option.

integer format: int64
name
required

The name of the option

string
color
required

The color of the option

string
multi_select_options

Details about the selected options

Array<object>
nullable
object
id
required

Unique identifier for the option.

integer format: int64
name
required

The name of the option

string
color
required

The color of the option

string
Examples
Example default 
[
  {
    "issue_field_id": 1,
    "issue_field_name": "DRI",
    "node_id": "IFT_GDKND",
    "data_type": "text",
    "value": "DRI"
  },
  {
    "issue_field_id": 2,
    "issue_field_name": "Priority",
    "node_id": "IFSS_SADMS",
    "data_type": "single_select",
    "value": 1,
    "single_select_option": {
      "id": 1,
      "name": "High",
      "color": "red"
    }
  },
  {
    "issue_field_id": 3,
    "issue_field_name": "Points",
    "node_id": "IFN_POINTS",
    "data_type": "number",
    "value": 42
  },
  {
    "issue_field_id": 4,
    "issue_field_name": "Due Date",
    "node_id": "IFD_DUEDATE",
    "data_type": "date",
    "value": "2025-12-25"
  },
  {
    "issue_field_id": 5,
    "issue_field_name": "Labels",
    "node_id": "IFMS_LABELS",
    "data_type": "multi_select",
    "value": "Frontend,Backend",
    "multi_select_options": [
      {
        "id": 1,
        "name": "Frontend",
        "color": "blue"
      },
      {
        "id": 2,
        "name": "Backend",
        "color": "green"
      }
    ]
  }
]

400

Section titled “ 400 ”

Bad Request

Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

Section titled “ 422 ”

Validation failed, or the endpoint has been spammed.

Media type application/json
Validation Error

Validation Error

object
message
required
string
documentation_url
required
string
errors
Array<object>
object
resource
string
field
string
message
string
code
required
string
index
integer
value
One of:
string
nullable
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}

503

Section titled “ 503 ”

Service unavailable

Media type application/json
object
code
string
message
string
documentation_url
string
Example generated 
{
  "code": "example",
  "message": "example",
  "documentation_url": "example"
}