Create a Deal
Create a new deal in your organization.
Endpoint
POST/deals
Request
Loading editor...
Response
json Loading editor...
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | Number | Yes | ID of the organization to create the deal in |
name | String | Yes | Name of the deal |
amount | Number | Yes | The monetary value of the deal |
currency | String | Yes | The currency code (e.g., "USD", "EUR") |
status | String | Yes | Deal status ('open', 'won', 'lost') |
pipeline_id | Number | Yes | ID of the pipeline this deal belongs to |
pipeline_stage_id | Number | Yes | ID of the pipeline stage this deal is currently in |
contact_id | Number | No | ID of the contact associated with this deal |
company_id | Number | No | ID of the company associated with this deal |
owned_by_user_id | Number | No | ID of the user who owns this deal (defaults to creator) |
expected_close_date | String | No | Expected date of deal closure (ISO 8601 format) |
Report an issue with this documentation
Please log in to report issues with our documentation.