Create deal
freshsales_create_dealWRITE: create a deal. name, amount and sales_account_id are required; contact_ids attach existing contacts. Stage and pipeline default to the first of the default pipeline. POST /deals.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Deal name. | |
| amount | Yes | Deal value in the account's default currency. | |
| owner_id | No | Owner user id (freshsales_list_owners). | |
| contact_ids | No | Existing contact ids to attach to the deal. | |
| probability | No | Win probability, 0-100. | |
| custom_field | No | Custom field values keyed by field name, e.g. {"cf_is_active": true}. Field names start with cf_. | |
| deal_type_id | No | Deal type id (freshsales_list_options deal_types). | |
| deal_stage_id | No | Stage id (freshsales_list_deal_stages). | |
| expected_close | No | Expected close date, YYYY-MM-DD. | |
| lead_source_id | No | Lead source id (freshsales_list_options lead_sources). | |
| deal_pipeline_id | No | Pipeline id (freshsales_list_deal_pipelines). | |
| sales_account_id | Yes | Company the deal belongs to. |