v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue worklogs

Update worklog

Updates a worklog.

Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking.

This operation can be accessed anonymously.

Permissions required:

  • Browse projects project permission for the project that the issue is in.
  • If issue-level security is configured, issue-level security permission to view the issue.
  • Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
  • If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
put/rest/api/3/issue/{issueIdOrKey}/worklog/{id}

Path parameters

issueIdOrKeystring required

The ID or key the issue.

idstring required

The ID of the worklog.

Query parameters

notifyUsersboolean

Whether users watching the issue are notified by email.

adjustEstimate'new' | 'leave' | 'manual' | 'auto'

Defines how to update the issue's time estimate, the options are:

  • new Sets the estimate to a specific value, defined in newEstimate.
  • leave Leaves the estimate unchanged.
  • auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.
newEstimatestring

The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.

expandstring

Use expand to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties.

overrideEditableFlagboolean

Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.

Request body

{"stackTrail":"components:schemas:Worklog:properties:comment","oasType":"schema","type":"unknown","description":"A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog."}
createdstring date-time

The datetime on which the worklog was created.

idstring

The ID of the worklog record.

issueIdstring

The ID of the issue this worklog is for.

selfstring uri

The URL of the worklog item.

startedstring date-time

The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

timeSpentstring

The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.

timeSpentSecondsinteger

The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

updatedstring date-time

The datetime on which the worklog was last updated.

Response

Returned if the request is successful

{"stackTrail":"components:schemas:Worklog:properties:comment","oasType":"schema","type":"unknown","description":"A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog."}
createdstring date-time

The datetime on which the worklog was created.

idstring

The ID of the worklog record.

issueIdstring

The ID of the issue this worklog is for.

selfstring uri

The URL of the worklog item.

startedstring date-time

The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.

timeSpentstring

The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.

timeSpentSecondsinteger

The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.

updatedstring date-time

The datetime on which the worklog was last updated.