Web Form Post API (Contacts)
This application programming interface describes the html markup for a valid form post transmission to the SalesOptima system. You must have a valid account in good standing to use this API.Related Resources: How do I create a company record? | How do I create a lead record?
Caution: Do not attempt to use this API if you are not familiar with HTML and have not been properly training by a SalesOptima representative. If you misuse this API, your account may be locked and fees may apply.
| Form Attribute | Value |
| Action | https://post.salesoptima.com/wcmpost.aspx |
| Test Action | https://post.salesoptima.com/apipostcheck.aspx |
| Method | Post |
Note: The Request ID below refers to the variables within the post that the API expects and will process accordingly.
| Request ID | Example | Contact Field/Mapping Notes | ||||||||||||||||||
| Important: The following fields are mandatory and should be added to your page as hidden fields | ||||||||||||||||||||
| LinkCode | This is the code that identifies which Web Form to post data against. Mandatory Hidden Field |
|||||||||||||||||||
| RedirectURL | http://www.yourcompany.com | This is the URL that will be used to redirect the browser once the form has been submitted. Mandatory Hidden Field |
||||||||||||||||||
| txtContactSettings | 1 |
|
||||||||||||||||||
| txtContactOverWrite | 1 |
|
||||||||||||||||||
| All of the following fields are optional. | ||||||||||||||||||||
| txtContactID | 1406044 | System Contact ID Used For Duplicate Detection | ||||||||||||||||||
| txtFirstName | Joe | First Name | ||||||||||||||||||
| txtLastName | Sample | Last Name | ||||||||||||||||||
| txtSalutation | Mr. | Salutation | ||||||||||||||||||
| txtTitle | Sales Manager | Title | ||||||||||||||||||
| txtCompanyName | Sample Corp | Company (Company Module Settings Addendum - How do I create a company record?) | ||||||||||||||||||
| txtAdd1 | 123 Sample Drive | Address 1 | ||||||||||||||||||
| txtAdd2 | Suite 1500 | Address 2 | ||||||||||||||||||
| txtAdd3 | Attention: Joe | Address 3 | ||||||||||||||||||
| txtCity | SamplesVille | City | ||||||||||||||||||
| txtState | IL | State | ||||||||||||||||||
| txtZip | 62154 | Zip | ||||||||||||||||||
| txtCountry | USA | Country | ||||||||||||||||||
| txtCustom1 | PO Box 5433 | Custom Text Field 1 | ||||||||||||||||||
| txtCustom2 | Custom Text Field 2 | |||||||||||||||||||
| txtCustom3 | Custom Text Field 3 | |||||||||||||||||||
| txtCustom4 | Sampleville | Custom Text Field 4 | ||||||||||||||||||
| txtCustom5 | IL | Custom Text Field 5 | ||||||||||||||||||
| txtCustom6 | 64125-5433 | Custom Text Field 6 | ||||||||||||||||||
| txtCustom7 | USA | Custom Text Field 7 | ||||||||||||||||||
| txtCustom8 | 2 bedroom | Custom Text Field 8 | ||||||||||||||||||
| txtCustom9 | 2 bathroom | Custom Text Field 9 | ||||||||||||||||||
| txtCheck1 | TRUE | Custom Checkbox 1 True/False or 1/0 | ||||||||||||||||||
| txtCheck2 | FALSE | Custom Checkbox 2 True/False or 1/0 | ||||||||||||||||||
| txtPhone | 1235551212 | Business Phone | ||||||||||||||||||
| txtHomePhone | 1235551213 | Home Phone | ||||||||||||||||||
| txtMobile | 1235551214 | Mobile | ||||||||||||||||||
| txtOtherPhone | 1235551215 | Other Phone | ||||||||||||||||||
| txtFax | 1235551216 | Fax | ||||||||||||||||||
| txtOtherFax | 1235551217 | Other Fax | ||||||||||||||||||
| txtEmail | joe@samplecorp.com | Primary Email Used For Duplicate Detection | ||||||||||||||||||
| txtEmail2 | joe@hotmail.com | Email 2 | ||||||||||||||||||
| txtEmail3 | joe@gmail.com | Email 3 | ||||||||||||||||||
| txtWebSite | www.samplecorp.com | WebSite | ||||||||||||||||||
| txtForceOwner | VR90001 | CLP User Code (CLP User Code Values Can Be Found Here) Used to Change Owner of Contact | ||||||||||||||||||
| txtCommentsTitle | Additional Information: | Prefix to Comments | ||||||||||||||||||
| txtComments | I love bunnies. | Comments | ||||||||||||||||||
| The following Note fields will be compiled into a single contact history entry. Each title/note combination must have a number associated with it between 1 and 100.Use with caution: The amount of data gathered can grow very quickly for each contact because usually these are textarea fields | ||||||||||||||||||||
| txtNoteTypeCode | 1234 | Note Type Dropdown must be a valid Note Type code | ||||||||||||||||||
| txtNote1Title | What is your favorite color? | Question/Comment attached to txtNote1 usually a hidden field | ||||||||||||||||||
| txtNote1 | Red | User Feedback to the Question/Comment above. | ||||||||||||||||||
| txtNote2Title | What is your favorite animal? | Question/Comment attached to txtNote2 usually a hidden field | ||||||||||||||||||
| txtNote2 | I told you already, bunnies. | User Feedback to the Question/Comment above. | ||||||||||||||||||
| txtNote3Title | How did you hear about us? | Question/Comment attached to txtNote3 usually a hidden field | ||||||||||||||||||
| txtNote3 | Internet | User Feedback to the Question/Comment above. | ||||||||||||||||||
| txtNote4Title | What product are you interested in? | Question/Comment attached to txtNote4 usually a hidden field | ||||||||||||||||||
| txtNote4 | Widget 1000 LS | User Feedback to the Question/Comment above. | ||||||||||||||||||
| txtNote5Title | Are you the one with the cash? | Question/Comment attached to txtNote5 usually a hidden field | ||||||||||||||||||
| txtNote5 | No, I'm research on behalf of my boss. | User Feedback to the Question/Comment above. | ||||||||||||||||||
| The following Link fields will be appended to into a single contact history entry. Each title/link combination must have a number associated with it between 1 and 10.Use with caution: The amount of data gathered can grow very quickly for each contact. | ||||||||||||||||||||
| txtLink1Title | What is your favorite CRM? | Question/Comment attached to txtLink1 usually a hidden field | ||||||||||||||||||
| txtLink1 | http://www.salesoptima.com | Fully qualifed URL link | ||||||||||||||||||
| txtLink2Title | Where do you get your news? | Question/Comment attached to txtLink2 usually a hidden field | ||||||||||||||||||
| txtLink2 | http://www.msn.com | Fully qualifed URL link | ||||||||||||||||||
| The following classification fields correspond to the available customizable dropdowns up to 8. see Step 1 of the CSV Upload Wizards for your account's code mapping |
||||||||||||||||||||
| txtClass1 | 5695 | Classification 1 Dropdown must be a valid Class1 code | ||||||||||||||||||
| txtClass2 | 8569 | Classification 2 Dropdown must be a valid Class2 code | ||||||||||||||||||
| The following fields correspond to more fields section of a contact. | ||||||||||||||||||||
| txtCustomDate1Title | What is your anniversary? | Custom Date 1 Title | ||||||||||||||||||
| txtCustomDate1 | 10/3/1998 | Custom Date 1 must be a valid date | ||||||||||||||||||
| txtCustomDate2Title | Annual financial review | Custom Date 2 Title | ||||||||||||||||||
| txtCustomDate2 | 7/5/2005 | Custom Date 2 must be a valid date | ||||||||||||||||||
| txtCustomDate3Title | Annual financial review | Custom Date 3 Title | ||||||||||||||||||
| txtCustomDate3 | 7/5/2005 | Custom Date 3 must be a valid date | ||||||||||||||||||
| txtCustomText1 | Amy | Custom Text 1 | ||||||||||||||||||
| txtCustomText2 | 4 kids | Custom Text 2 | ||||||||||||||||||
| txtCustomText3 | and 1 bunny | Custom Text 3 | ||||||||||||||||||