Name | Type | Description | Notes |
---|---|---|---|
title | String | Deal title | |
value | String | Value of the deal. If omitted, value will be set to 0. | [optional] |
currency | String | Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user. | [optional] |
userId | Number | ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used. | [optional] |
personId | Number | ID of the person this deal will be associated with | [optional] |
orgId | Number | ID of the organization this deal will be associated with | [optional] |
stageId | Number | ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id). If omitted, the deal will be placed in the first stage of the default pipeline. | [optional] |
status | String | open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open. | [optional] |
expectedCloseDate | Date | The expected close date of the Deal. In ISO 8601 format: YYYY-MM-DD. | [optional] |
probability | Number | Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled. | [optional] |
lostReason | String | Optional message about why the deal was lost (to be used when status=lost) | [optional] |
visibleTo | VisibleTo | Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<dl class="fields-list"><dt>1</dt><dd>Owner & followers (private)</dd><dt>3</dt><dd>Entire company (shared)</dd></dl> | [optional] |
addTime | String | Optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] |
-
open
(value:"open"
) -
won
(value:"won"
) -
lost
(value:"lost"
) -
lost
(value:"lost"
) -
deleted
(value:"deleted"
)