jira.js
    Preparing search index...

    Function updateSprint

    • Performs a full update of a sprint. A full update means that the result will be exactly the same as the request body. Any fields not present in the request JSON will be set to null. Notes:

      • Sprints that are in a closed state cannot be updated.
      • A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.
      • A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request. If the sprint has offending issues (those which are complete, but have incomplete subtasks) it cannot be closed. If issues are moved to new sprint user has to have issues edit permissions.
      • Other changes to state are not allowed.
      • The completeDate field cannot be updated manually.
      • Only Jira administrators can edit dates on sprints that are marked as synced.

      Parameters

      • client: Client
      • parameters: {
            activatedDate?: string;
            autoStartStop?: boolean;
            completeDate?: string;
            endDate?: string;
            goal?: string;
            id?: number;
            incompleteIssuesDestinationId?: number;
            name?: string;
            originBoardId?: number;
            self?: string;
            sprintId: number;
            startDate?: string;
            state?: string;
            synced?: boolean;
        }
        • OptionalactivatedDate?: string
        • OptionalautoStartStop?: boolean
        • OptionalcompleteDate?: string
        • OptionalendDate?: string
        • Optionalgoal?: string
        • Optionalid?: number
        • OptionalincompleteIssuesDestinationId?: number
        • Optionalname?: string
        • OptionaloriginBoardId?: number
        • Optionalself?: string
        • sprintId: number

          The Id of the sprint to update.

        • OptionalstartDate?: string
        • Optionalstate?: string
        • Optionalsynced?: boolean
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              activatedDate?: string;
              autoStartStop?: boolean;
              completeDate?: string;
              endDate?: string;
              goal?: string;
              id?: number;
              incompleteIssuesDestinationId?: number;
              name?: string;
              originBoardId?: number;
              self?: string;
              startDate?: string;
              state?: string;
              synced?: boolean;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility