AddDeal

Overview

Adds a deal to the database via an http form post.

URL

POST/api/2/AddDeal.aspx

Parameters

FieldMax LengthRequiredNotes
response_typefalseDefault results will be returned in XML.
Set this field value to json to return results in JSON format
accountidtrueMust be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
apikeytrueAPI Key for this account.
Found in Settings > API Settings or for White Label CRM in the Admin control panel
teammemberidfalseMust be numeric. Team Member ID.
Defaults to 0 (Account Owner).
dealnamefalseName of the deal / description
dealtypetrueMust match a Deal Type by string value
dealstagetrueMust match a Deal Stage (for the selected Deal Type) by string value
dealstatustruePossible Values:
Active, Won, Lost, Back Burner
probabilityfalseNumeric, from 0 to 100, in increments of 5.
showonstagescreen1falseShow on Deals By Stage Screen
1: Yes
0: No
amountfalsedecimal value. do not use commas or currency symbols
commissionfalsedecimal value. do not use commas or currency symbols
openeddatefalseUS Date format
mm/dd/yyyy
expectedclosedatefalseUS Date format
mm/dd/yyyy
actualclosedatefalseUS Date format
mm/dd/yyyy
nextstep40false
lostreason50false
notefalseCreates a Deal Note for this new deal
primarycontactidfalseCreates a link to a contact
customtext#30false#1 through #6
customdropdown#30false#1 through #6
custommemo#false#1 through #2
customcheckbox#false#1 through #6
Value must be true or false
customdate#false#1 through #3
Must be in US date format MM/DD/YYYY
customnumber#false#1 through #3
Must be numeric, no decimals
customcurrency#false#1 through #3
Must be numeric up to 2 decimal places
custominterest1falseMust be numeric up to 3 decimal places
triggeractionset1falseSet value to "1" to trigger the Action Set (or Workflow) if stage is configured to trigger one (Default "0", don't trigger)