Sample - GitHub REST API
POST/users/{username}/projectsV2/{project_number}/fields

Add field to user owned project

Add a field to a specified user owned project.

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

2 parameters · 2 body fields
usernamestringrequired
The handle for the GitHub user account.
project_numberintegerrequired
The project's number.
namestringrequired
The name of the field.
data_typestringrequired
The field's data type.
Allowed:textnumberdate

5 status codes
201Response
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.
304Not modified
401Requires authentication
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 422 is returned: Validation failed, or the endpoint has been spammed.

Was this helpful?