provider Plans PUT /rest/api/3/plans/plan/{planId}
@utdk/jira /rest/api/3/plans/plan/{planId}
Update plan
Updates any of the following details of a plan using [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902). * 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). *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.*
planId path required
The ID of the plan.
integer
useGroupId query
Whether to accept group IDs instead of group names. Group names are deprecated.
boolean

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

updateplan
PUT/rest/api/3/plans/plan/{planId}
Updates any of the following details of a plan using [JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902). * 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](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). *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.*

Parameters

required

The ID of the plan.

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.updateplan({
  "useGroupId": false
})