Function createSprint

createSprint(
    client: Client,
    parameters: {
        autoStartStop?: boolean;
        endDate?: string;
        goal?: string;
        incompleteIssuesDestinationId?: number;
        name?: string;
        originBoardId?: number;
        startDate?: string;
        synced?: boolean;
        userProfileTimeZone?: string;
    },
    options?: RequestOptions,
): 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;
    },
>
Creates a future sprint. Sprint name and origin board id are required. Start and end date are optional. Notes: The sprint name is trimmed. Only Jira administrators can create synced sprints.
Parameters
- client: Client
- parameters: {
      autoStartStop?: boolean;
      endDate?: string;
      goal?: string;
      incompleteIssuesDestinationId?: number;
      name?: string;
      originBoardId?: number;
      startDate?: string;
      synced?: boolean;
      userProfileTimeZone?: string;
  }
- 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;
    },
>
- Defined in src/server/api/sprint.ts:24

Function createSprint

Parameters

Settings