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:

      • For closed sprints, only the name and goal can be updated; changes to other fields will be ignored.
      • 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.
      • Other changes to state are not allowed.
      • The completeDate field cannot be updated manually.

      Parameters

      • client: Client
      • parameters: {
            completeDate?: string | Date;
            createdDate?: string | Date;
            endDate?: string | Date;
            goal?: string;
            id?: number;
            name: string;
            originBoardId?: number;
            sprintId: number;
            startDate?: string | Date;
            state: string;
        }
        • OptionalcompleteDate?: string | Date
        • OptionalcreatedDate?: string | Date
        • OptionalendDate?: string | Date
        • Optionalgoal?: string
        • Optionalid?: number
        • name: string
        • OptionaloriginBoardId?: number
        • sprintId: number

          The ID of the sprint to update.

        • OptionalstartDate?: string | Date
        • state: string
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              completeDate?: Date;
              createdDate?: Date;
              endDate?: Date;
              goal?: string;
              id?: number;
              name?: string;
              originBoardId?: number;
              self?: string;
              startDate?: Date;
              state: "active"
              | "closed"
              | string & {}
              | "future";
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility