GitHub API (unofficial showcase)
POST/orgs/{org}/projectsV2/{project_number}/fields

Create a field in an organization-owned project

Creates a field in an organization-owned project. Supply a request body matching a supported field configuration, such as an issue field reference or a named field with its data type. A single-select field configuration includes its available options.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
project_numberintegerrequired
The project's number.
orgstringrequired
The organization name; the name is not case sensitive.

Field configuration for the organization-owned project. Choose a supported configuration and provide the fields required for that configuration.

issue_field_idintegerrequired
The ID of the IssueField to create the field for.

5 status codes
201Returns the created project field, including its identifier, name, data type, project URL, and creation and update timestamps.
idintegerrequired
The unique identifier of the field.
issue_field_idintegeroptional
The ID of the issue field.
node_idstringoptional
The node ID of the field.
project_urlstringrequired
The API URL of the project that contains the field.
namestringrequired
The name of the field.
data_typestringrequired
The field's data type.
Allowed:assigneeslinked_pull_requestsreviewerslabelsmilestonerepositorytitletextsingle_selectnumberdateiteration
optionsarray<ProjectsV2SingleSelectOption>optional
The options available for single select fields.
configurationobjectoptional
Configuration for iteration fields.
created_atstringrequired
The time when the field was created.
updated_atstringrequired
The time when the field was last updated.
304Returned when the resource has not changed since the version held by the caller.
401Returned when the request requires authentication.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Returned when access to the project is forbidden.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when the field configuration fails validation or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 401 is returned when the request is not authenticated, and a 403 is returned when access is forbidden. A 422 is returned when the field configuration fails validation or the endpoint has been spammed. Provide either issue_field_id, name with data_type, or the required fields for a single-select field; data_type must match the selected configuration, and single-select options must include at least one option.