Overview
Adds a deal to the database via an http form post.
Post Url
https://www.allclients.com/api/2/AddDeal.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
| Field | Max Length* | Required | Notes |
| response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
| accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
| teammemberid | No | Must be numeric. Team Member ID. Defaults to 0 (Account Owner). | |
| dealname | No | Name of the deal / description | |
| dealtype | Yes | Must match a Deal Type by string value | |
| dealstage | Yes | Must match a Deal Stage (for the selected Deal Type) by string value | |
| dealstatus | Yes | Possible Values: Active, Won, Lost, Back Burner |
|
| probability | No | Numberic, from 0 to 100, in increments of 5. | |
| showonstagescreen | 1 | No | Show on Deals By Stage Screen 1: Yes 0: No |
| amount | No | decimal value. do not use commas or currency symbols | |
| commission | No | decimal value. do not use commas or currency symbols | |
| openeddate | No | US Date format mm/dd/yyyy |
|
| expectedclosedate | No | US Date format mm/dd/yyyy |
|
| actualcloseddate | No | US Date format mm/dd/yyyy |
|
| nextstep | 40 | No | |
| lostreason | 50 | No | |
| note | No | Creates a Deal Note for this new deal | |
| primarycontactid | No | Creates a link to a contact | |
| customtext# | 30 | No | # 1 through #6 |
| customdropdown# | 30 | No | # 1 through #6 |
| custommemo# | No | # 1 through #2 | |
| customcheckbox# | No | # 1 through #6 Value must be true or false |
|
| customdate# | No | # 1 through #3 Must be in US date format MM/DD/YYYY |
|
| customnumber# | No | # 1 through #3 Must be numeric, no decimals |
|
| customcurrency# | No | # 1 through #3 Must be numeric up to 2 decimal places |
|
| custominterest1 | No | Must be numeric up to 3 decimal places | |
| triggeractionset | 1 | No | Set value to “1” to trigger the Action Set (or Workflow) if stage is configured to trigger one (Default “0”, don’t trigger) |
* An error will not result if Max Length is exceeded. Data will be trimmed to this length.
Sample Results
Success Message
<?xml version="1.0"?>
<results>
<message>Success</message>
<dealid>15631</dealid>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>
