Update deal stage
Move a deal to another sales stage or pipeline.
PATCH https://cotlet.dev/api/v1/vtiger/records/{record_id}/deal-stage
Moves one deal like dragging it between columns of the Kanban view. With pipeline, it does what Change Pipeline does: pick the new pipeline and stage, and optionally the probability. A stage name your pipeline does not have fails, and the error lists the stages. Contacts can get emails from your Vtiger workflows when a stage changes. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| record_id string required | string | Deal record id from list_deals. |
| sales_stage string required | string | Target sales stage, named as in the pipeline. |
| pipeline string | string | Target pipeline, only to move the deal to another pipeline. |
| probability integer | integer | Probability in percent, optional. |
Request
curl -X PATCH https://cotlet.dev/api/v1/vtiger/records/2041/deal-stage \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"sales_stage":"Negotiation","probability":75}' result = client.call("vtiger", "update_deal_stage", {"record_id":"2041","sales_stage":"Negotiation","probability":75}) const result = await cotlet.call('vtiger', 'update_deal_stage', {"record_id":"2041","sales_stage":"Negotiation","probability":75}); cotlet call vtiger update_deal_stage --data '{"record_id":"2041","sales_stage":"Negotiation","probability":75}' Example response
{
"record_id": "2041",
"name": "Whitfield Dental, 5 seats",
"sales_stage": "Negotiation",
"pipeline": "Standard",
"probability": 75
}