Updates a phase

put

http://localhost:3001/api/{team_id}/phase/{phase_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

number

required

Team ID

phase_id

number

required

Phase ID

Body Params

api_request_metadata

object

API Request Metadata

apply_cost_rate_multiplier_to_activity_phases

boolean

Applies the cost rate multiplier to all activity phases under the phase (default: false)

apply_rate_multiplier_to_activity_phases

boolean

Applies the rate multiplier to all activity phases under the phase (default: false)

billable

boolean

Set Phase as billable if set true

billing_type

string

Type of the Bill Rate; one of: 'employee', 'work_category', or 'role'

budget_fixed_fee_with

string

If fee_type is fixed, affects how cost estimation is calculated on phase; options are 'phase_estimate', 'member_estimates', 'spent_and_planned', 'work_category_estimates'

budget_hourly_with

string

If fee_type is hourly, affects how cost estimation is calculated on phase; options are 'phase_estimate', 'member_estimates', 'spent_and_planned', 'work_category_estimates'

budget_phase_by

string

Budget option when phase is hours only; options are 'total hours', 'member estimates', 'spent and planned'

budget_status

string

Status of the phase budget; options are 'not started', 'hold', 'active', and 'complete'

cost_rate_multiplier

number

Default Cost Rate Multiplier for the activity phases under this phase

dependable_phase_id

number

ID of the dependent phase

dependency_type

string

Type of the dependency - options are: EndDate, StartDate, StartEndDate, StartToEndDate, EndToStartDate

end_date

date

End Date (MM/DD/YYYY)

estimated_cost

number

Budget of the phase

estimated_hours

number

Estimated Hours; need budget_activity_phase_by to be 'total hours to use'

fee_type

string

Type of Fee (Contract Type); one of: 'Fixed Fee' or 'Hourly'

is_archived

boolean

Set Phase as archived if set true

is_budget

boolean

Set Phase as budget (Default: false); set true to make it a phase rather than a milestone

is_main

boolean

Set Phase as main if set true

move_action

string

'indent' = move after last child of the last sibling. 'dedent' = move after and become a sibling of the parent phase.

move_after_phase_id

number

ID of the sibling phase node which new sub-phase will be created after

name

string

required

Title of Phase

new_project_id

number

New Project ID to move the phase to

parent_id

number

ID of the parent phase node which new sub-phase will be created under

phase_number

string

Phase Number

profit_percentage

number

Profit Percentage = (100 - % of Fee); used to determine the estimated_cost when fee_type is 'Fixed Fee' and budget_fixed_fee_with is 'phase_estimate' estimated_cost = total * (100 - profit_percentage) / 100

project_id

number

required

Project ID

rate_group_id

number

Rate Group ID (overrides the rate group set on the project)

rate_multiplier

number

Default Bill Rate Multiplier for the activity phases under this phase

recursive_project_update

boolean

Update all sub-phases recursively

start_date

date

Start Date (MM/DD/YYYY)

total

number

Total Fee (Default: 0.0); used when fee_type is 'Fixed Fee'

Responses

200

Success

401

Invalid Authentication Key and/or Team ID