
Web Form Company Settings API
…continued from Web Form Post API
Note: This addendum describes the mappings used to create/edit a EngageCRM Company object when a NEW CONTACT IS CREATED using the Web Form Post API. If you do not have the Company Module installed, these settings do not apply to you.
This application programming interface describes the html markup for a valid form post transmission to the EngageCRM system. You must have a valid account in good standing to use this API.
Caution: Do not attempt to use this API if you are not familiar with HTML and have not been properly training by a EngageCRM representative. If you misuse this API, your account may be locked and fees may apply.
Related Resources: How do I create a contact record? | How do I create a lead record?
Note: The Request ID below refers to the variables within the post that the API expects and will process accordingly.
Important: The following fields are mandatory and should be added to your page as hidden fields
Request ID | Example | Contact Field/Mapping Notes |
---|---|---|
txtCompanySettings | 1 |
Mandatory Hidden Field 0 = Assign as personal contact (Default Action) Creates the contact as a personal contact. 1 = Duplicate Check Performs a duplicate check using the txtCompanyName field. a) If a duplicate company is detected, the contact will be assigned to the duplicate company. (Note: see txtCoOverWrite for rules on how data will be populated in duplicate company.) b) If no duplicate company is found, a new company will be created. (Note: see txtCoOverWrite for rules on how data will be populated in new company.) 2 = Always Create New Company Creates a new company using txtCompanyName. (Note: see txtCoOverWrite for rules on how data will be populated in new company.) |
txtContactOverWrite | 1 |
Mandatory Hidden Field 0 = Only Overwrite if blank (Default Action) All data fields present in post will populate their respective company fields within EngageCRM only if the field is blank or empty. 1 = Always Overwrite All data fields present in post will populate their respective company fields within EngageCRM. 2 = Ignore All data fields present in post will be ignored. |
All of the following fields are optional.
Request ID | Example | Contact Field/Mapping Notes |
---|---|---|
txtCompanyName | Sample Corp | Mandatory Field Company Name |
txtCoAdd1 | 123 Sample Drive | Address 1 (will use txtAdd1 if this field doesn't exist) |
txtCoAdd2 | SampSuite 1500 | Address 2 (will use txtAdd2 if this field doesn't exist) |
txtCoAdd3 | Attention: Joe | Address 3 (will use txtAdd3 if this field doesn't exist) |
txtCoCity | SamplesVille | City (will use txtCity if this field doesn't exist) |
txtCoState | IL | State (will use txtState if this field doesn't exist) |
txtCoZip | 62154 | Zip (will use txtZip if this field doesn't exist) |
txtCoCountry | USA | Country (will use txtCountry if this field doesn't exist) |
txtCoCustom1 | 1000+ employees | Custom Text Field 1 |
txtCoCustom2 | $4.7 Billion valuation | Custom Text Field 2 |
txtCoCustom3 | Alternate address 1 | Custom Text Field 3 |
txtCoCustom4 | Sampleville | Custom Text Field 4 |
txtCoCustom5 | IL | Custom Text Field 5 |
txtCoCustom6 | 64125-5433 | Custom Text Field 6 |
txtCoCustom7 | USA | Custom Text Field 7 |
txtCoCustom8 | 2 bedroom | Custom Text Field 8 |
txtCoCustom9 | 2 bathroom | Custom Text Field 9 |
txtCoCheck1 | TRUE | Custom Checkbox 1 True/False or 1/0 |
txtCoCheck2 | FALSE | Custom Checkbox 2 True/False or 1/0 |
txtCoCheck3 | FALSE | Custom Checkbox 3 True/False or 1/0 |
txtCoCheck4 | FALSE | Custom Checkbox 4 True/False or 1/0 |
txtCoPhone | 1235551212 | Phone (will use txtPhone if this field doesn't exist) |
txtCoFax | 1235551216 | Fax (will use txtFax if this field doesn't exist) |
txtCoWebSite | www.samplecorp.com | Website (will use txtWebsite if this field doesn't exist) |
txtCoCommentsTitle | Additional Information: | Prefix to Comments |
txtCoComments | I love turtles. | Comments |
The following classification fields correspond to the available customizable dropdowns (maximum of 8).
See Company Module settings for your company’s code mapping
Request ID | Example | Contact Field/Mapping Notes |
---|---|---|
txtCoClass1 | 5695 | Classification 1 Dropdown (must be a valid Class1 code) |
txtCoClass2 | 8569 | Classification 2 Dropdown (must be a valid Class2 code) |
txtCoClass3 | 3214 | Classification 3 Dropdown (must be a valid Class3 code) |
txtCoClass4 | 8965 | Classification 4 Dropdown (must be a valid Class4 code) |
txtCoClass5 | 6547 | Classification 5 Dropdown (must be a valid Class5 code) |
txtCoClass6 | 8547 | Classification 6 Dropdown (must be a valid Class6 code) |
txtCoClass7 | 8547 | Classification 7 Dropdown (must be a valid Class7 code) |
txtCoClass8 | 8547 | Classification 8 Dropdown (must be a valid Class8 code) |