Function: createSprint()

function createSprint(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  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;
}>;

Defined in: src/server/api/sprint.ts:24

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

Parameter	Type
client	Client
parameters	{ autoStartStop?: boolean; endDate?: string; goal?: string; incompleteIssuesDestinationId?: number; name?: string; originBoardId?: number; startDate?: string; synced?: boolean; userProfileTimeZone?: string; }
parameters.autoStartStop?	boolean
parameters.endDate?	string
parameters.goal?	string
parameters.incompleteIssuesDestinationId?	number
parameters.name?	string
parameters.originBoardId?	number
parameters.startDate?	string
parameters.synced?	boolean
parameters.userProfileTimeZone?	string
options?	RequestOptions

Returns

Promise<{ [key: string]: unknown; 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; }>