Deals
Manage sales deals and opportunities. Use action=“create” to record a new deal. Use action=“update” to modify a deal. Use action=“list” to search deals. Use action=“delete” to remove a deal record.
Input Schema
| Parameter | Type | Description |
|---|---|---|
| action | string | Action to perform on deals. Enum: create, list, update, delete |
| deal_id | string | Deal UUID (required for update/delete) |
| site_id | string | Site UUID |
| name | string | Deal name (required for create) |
| amount | number | Deal amount |
| currency | string | Currency code (e.g. USD) |
| stage | string | Deal stage in the sales pipeline (e.g. prospecting, proposal, negotiation, closed_won) |
| status | string | Overall deal status (e.g. open, won, lost) |
| company_id | string | Company UUID |
| expected_close_date | string | Date string for expected close (YYYY-MM-DD) |
| notes | string | Deal notes |
| qualification_score | number | Qualification score |
| qualification_criteria | object | JSON object with qualification specifics |
| sales_order_id | string | Related Sale/Order UUID if closed |
| lead_ids | array | Array of Lead UUIDs attached to this deal |
| owner_ids | array | Array of User UUIDs who own this deal |
| limit | number | Limit results |
| offset | number | Offset results |
REST Endpoint
Actions map to sub-routes: create → /create, list → /get, update → /update, delete → /delete.
POST /api/agents/tools/deals/create
GET /api/agents/tools/deals/get
POST /api/agents/tools/deals/update
POST /api/agents/tools/deals/deletePOST /api/agents/tools/deals/create
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"site_id": "YOUR_SITE_ID",
"name": "Acme Corp Q3 Renewal",
"amount": 10000,
"currency": "USD",
"stage": "proposal",
"status": "open"
}Response:
{
"success": true,
"deal": {
"id": "...",
"name": "Acme Corp Q3 Renewal",
"amount": 10000,
"stage": "proposal"
}
}Last updated on