createPhase( )

Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.

Creates a new workflow phase.

The createPhase() function returns a Promise that resolves to the created phase ID when the phase is created in the specified workflow.

Pass a value for the position parameter to specify the newly created phase's position within the specified workflow. Positions are zero-based, meaning the first position is 0. When omitted, the newly created phase is added as the last non-win phase.

This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.

Method Declaration
Method Parameters

ID of the workflow to add the new phase to.


Phase to create.


The created phase's position within the workflow.

Return Type:Promise<string>
Was this helpful?