PATCH/users/{username}/projectsV2/{project_number}/items/{item_id}

Update an item in a user-owned project

Updates field values on a specific item in a project owned by the specified user. Supply the field IDs and new values in fields; only text, number, date, single-select, and iteration fields are supported. A 200 response returns the updated project item.

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

3 parameters · 1 body field
project_numberintegerrequired
The number of the project containing the item.
usernamestringrequired
The handle of the user who owns the project.
item_idintegerrequired
The unique identifier of the project item to update.

Field updates to apply to the project item. Include a fields array with an identifier and value for each field to update.

fieldsarray<object>required
A list of field updates to apply.

5 status codes
200Returns the updated project item, including its identifier, content type, timestamps, and updated field values.
idnumberrequired
The unique identifier of the project item.
node_idstringoptional
The node ID of the project item.
project_urlstringoptional
The API URL of the project that contains this item.
content_typestringrequired
The type of content tracked in a project item
Allowed:IssuePullRequestDraftIssue
contentobjectoptional
The content of the item, which varies by content type.
creatorobjectoptional
A GitHub user.
created_atstringrequired
The time when the item was created.
updated_atstringrequired
The time when the item was last updated.
archived_atstringrequired
The time when the item was archived.
item_urlstringoptional
The API URL of this item.
fieldsarray<object>optional
The fields and values associated with this item.
401Returned when authentication is required but missing or invalid.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Returned when the authenticated user is not permitted to update the project item.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Returned when the requested resource is not found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when validation fails or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 401 is returned when authentication is required but missing or invalid. A 403 is returned when you are not permitted to update the project item. A 404 is returned when the requested resource is not found. A 422 is returned when validation fails or the endpoint has been spammed. The project_number path parameter, username path parameter, and item_id path parameter must identify the project and item. The fields array is required, and each entry must include id and value; supported fields are text, number, date, single select, and iteration. Set value to null to clear a field.