Parameter | Example | API version |
file_id | File identifier | integer | 34567 | |
stage_id | Stage identifier | integer | 36456 | |
name | Stage name | string | Stage 1 | |
deadline_date | The string identifying the deadline date for this stage. Format is determined by the account settings | string | March 24, 2014, 2:30 pm | |
start_trigger | Determines when the stage starts: 1 - Start immediately 2 - Start when a previous deadline is reached (will require the start_dependent_stage_id) 3 - Start on a specific date and time (will require the start_dependent_days / hours and minutes) 4 - Start when all decisions are approved or approved with changes 5 - Start when all decisions are approved 6 - Start when all decisions are made 7 - Start manually | integer | 1 | |
start_dependent_stage_id | If the start_trigger is set to 2 then this field determines the previous dependent stage | integer | 5645 | |
start_dependent_date | If start_trigger is set to 3 then this field determines the date the stage starts | string | March 24, 2014, 2:30 pm | |
stage_locking
| Determines when the stage should be locked:
1 - lock manually
2 - lock when next stage starts
3 - lock when all decisions are made
4 - never lock | integer | 1 | |
stage_primary_decision_maker_recipient_id | Recipient identifier of the primary decision maker | integer | 4564 | |
stage_one_decision_only
| Determines if only one decision is required on the stage | boolean
| true
| |
stage_private
| Determines if the stage is private or public | boolean
| true
| |
comments_count
| The total number of comments on this stage | integer | 10 | |
recipients_count | The total number of recipients on this stage | integer | 5 | |
decision | The current decision status of the proof. See the available decisions here and how the proof status is calculated here (Proof results: status).
| string | Approved / Approved with change / Changes required / Pending | 14.3 |
stage_start_date | The date the stage was started | string |
| 14.3 |
last_status_change_date | The date the last time a status was changed on the stage | string |
| 14.3 |
deadline_calculate_on | Whether the deadline is calculated from the proof creation date or from the stage activation date | integer | 1 - from proof creation
2 - from stage activation
| 14.4 |
active | Indicates if the stage is active or not | boolean | true
| 15.23 |
mandatory | Indicates if the stage is mandatory or not | boolean | true
| 17.19 |