Manage Stages
There is no dedicated stage-shift endpoint in Public API v2. Change stages by patching thestage attribute on the record.
For account lifecycle stage, use the account field current_stage_id instead of stage.
Contact stages
422 stage_entrance_criteria_not_met.
Opportunity stages
Opportunitystage is required when creating an opportunity.
stage attribute to move an opportunity:
Read-only opportunity fields
Do not write these fields directly:outcomestatusclosed_atstage_last_shifted_at
Common errors
| Error code | Usually means | How to recover |
|---|---|---|
field_required_missing | Opportunity create omitted display_name, stage, or account_id | Include all required fields in the create request |
field_value_invalid | Stage value could not be resolved | Use a valid stage ID, API name, or display value |
field_not_updatable | Request tried to write a read-only stage-related field | Remove read-only fields from the request |
stage_entrance_criteria_not_met | Contact stage move is blocked by criteria | Fix the missing prerequisites before retrying |