v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB
Plans

Update plan

Updates any of the following details of a plan using JSON Patch.

  • name

  • leadAccountId

  • scheduling

    • estimation with StoryPoints, Days or Hours as possible values

    • startDate

      • type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
      • dateCustomFieldId
    • endDate

      • type with DueDate, TargetStartDate, TargetEndDate or DateCustomField as possible values
      • dateCustomFieldId
    • inferredDates with None, SprintDates or ReleaseDates as possible values

    • dependencies with Sequential or Concurrent as possible values

  • issueSources

    • type with Board, Project or Filter as possible values
    • value
  • exclusionRules

    • numberOfDaysToShowCompletedIssues
    • issueIds
    • workStatusIds
    • workStatusCategoryIds
    • issueTypeIds
    • releaseIds
  • crossProjectReleases

    • name
    • releaseIds
  • customFields

    • customFieldId
    • filter
  • permissions

    • type with View or Edit as possible values

    • holder

      • type with Group or AccountId as possible values
      • value

Permissions required: Administer Jira global permission.

Note that "add" operations do not respect array indexes in target locations. Call the "Get plan" endpoint to find out the order of array elements.

put/rest/api/2/plans/plan/{planId}

Path parameters

planIdinteger required

The ID of the plan.

Query parameters

useGroupIdboolean

Whether to accept group IDs instead of group names. Group names are deprecated.

Response

Returned if the request is successful.

{"stackTrail":"paths:/rest/api/2/plans/plan/{planId}:put:responses:204:content:application/json:schema","oasType":"schema","type":"unknown"}