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
Mandatory Hidden Field
0=Duplicate Check (Default Action)
  Performs a duplicate check using the txtEmail, txtEmail2, and txtEmail3 fields.
a) If a duplicate contact is detected, that contact will be updated.
(Note: see txtContactOverWrite for rules on how data will be populated in duplicate contact.)
b) If no duplicate contact is found, a new contact will be created.
(Note: see txtContactOverWrite for rules on how data will be populated in new contact.)
c) If txtPhone should be used to find duplicates, include txtCheckDupByPhone with a value of "1".
1=Always Create New Contact
  Creates a new contact.
(Note: see txtContactOverWrite for rules on how data will be populated in new contact.)
2=Duplicate Check (Override Security Settings)
  Performs the same duplicate check as 0 (see above) except your company's security settings are ignored. By default, the security model in place for your account will govern how the API searches your database to determine duplicates. By using this variable, you can instruct the API to ignore your security model and search your company's entire database. This is especially helpful when one web form will be shared by all users (i.e. Unsubscribe form).
txtContactOverWrite 1
Mandatory Hidden Field
0=Only Overwrite if blank (Default Action)
 All data fields present in post will populate their respective contact fields within SalesOptima only if the field is blank or empty.
1=Always Overwrite
 All data fields present in post will populate their respective contact fields within SalesOptima.
2=Ignore
 All data fields present in post will be ignored.
3 = Always Overwrite (unless form field is empty)
 All NON-EMPTY data fields present in post will populate their respective contact fields within SalesOptima.
All of the following fields are optional.
txtContactID1406044System Contact ID
Used For Duplicate Detection
txtFirstNameJoeFirst Name
txtLastNameSampleLast Name
txtSalutationMr.Salutation
txtTitleSales ManagerTitle
txtCompanyNameSample CorpCompany (Company Module Settings Addendum - How do I create a company record?)
txtAdd1123 Sample DriveAddress 1
txtAdd2Suite 1500Address 2
txtAdd3Attention: JoeAddress 3
txtCitySamplesVilleCity
txtStateILState
txtZip62154Zip
txtCountryUSACountry
txtCustom1PO Box 5433Custom Text Field 1
txtCustom2Custom Text Field 2
txtCustom3Custom Text Field 3
txtCustom4SamplevilleCustom Text Field 4
txtCustom5ILCustom Text Field 5
txtCustom664125-5433Custom Text Field 6
txtCustom7USACustom Text Field 7
txtCustom82 bedroomCustom Text Field 8
txtCustom92 bathroomCustom Text Field 9
txtCheck1TRUECustom Checkbox 1
True/False or 1/0
txtCheck2FALSECustom Checkbox 2
True/False or 1/0
txtPhone1235551212Business Phone
txtCheckDupByPhone1If txtPhone should be used to find duplicates, include txtCheckDupByPhone with a value of "1".
txtHomePhone1235551213Home Phone
txtMobile1235551214Mobile
txtOtherPhone1235551215Other Phone
txtFax1235551216Fax
txtOtherFax1235551217Other Fax
txtEmailjoe@samplecorp.comPrimary Email
Used For Duplicate Detection
txtEmail2joe@hotmail.comEmail 2
txtEmail3joe@gmail.comEmail 3
txtWebSitewww.samplecorp.comWebSite
txtForceOwnerVR90001CLP User Code (CLP User Code Values Can Be Found Here)
Used to Change Owner of Contact
txtCommentsTitleAdditional Information:Prefix to Comments
txtCommentsI love bunnies.Comments
txtCommentsAppendI also love rabbits.Apends to Comments field
The following multiple fields will be compiled into a single Comments field entry. Each title/note combination must have a number associated with it between 1 and 10.
txtMultiComments1TitleFirst MilestoneQuestion/Comment attached to txtMultiComments1
usually a hidden field
txtMultiComments1Delivered by Frank SmithUser Feedback to the Question/Comment above.
txtMultiComments2TitleProject RequirementsQuestion/Comment attached to txtMultiComments2
usually a hidden field
txtMultiComments2Contract signed. Awaiting payment.User Feedback to the Question/Comment above.
txtMultiComments3TitleHow did you hear about us?Question/Comment attached to txtMultiComments3
usually a hidden field
txtMultiComments3InternetUser Feedback to the Question/Comment above.
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
txtNoteTypeCode1234Note Type Dropdown
must be a valid Note Type code
txtNote1TitleWhat is your favorite color?Question/Comment attached to txtNote1
usually a hidden field
txtNote1RedUser Feedback to the Question/Comment above.
txtNote2TitleWhat is your favorite animal?Question/Comment attached to txtNote2
usually a hidden field
txtNote2I told you already, bunnies.User Feedback to the Question/Comment above.
txtNote3TitleHow did you hear about us?Question/Comment attached to txtNote3
usually a hidden field
txtNote3InternetUser Feedback to the Question/Comment above.
txtNote4TitleWhat product are you interested in?Question/Comment attached to txtNote4
usually a hidden field
txtNote4Widget 1000 LSUser Feedback to the Question/Comment above.
txtNote5TitleAre you the one with the cash?Question/Comment attached to txtNote5
usually a hidden field
txtNote5No, 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.
txtLink1TitleWhat is your favorite CRM?Question/Comment attached to txtLink1
usually a hidden field
txtLink1http://www.salesoptima.comFully qualifed URL link
txtLink2TitleWhere do you get your news?Question/Comment attached to txtLink2
usually a hidden field
txtLink2http://www.msn.comFully 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
txtClass15695Classification 1 Dropdown
must be a valid Class1 code
txtClass28569Classification 2 Dropdown
must be a valid Class2 code
The following fields correspond to more fields section of a contact.
txtCustomDate1TitleWhat is your anniversary?Custom Date 1 Title
txtCustomDate110/3/1998Custom Date 1
must be a valid date
txtCustomDate2TitleAnnual financial reviewCustom Date 2 Title
txtCustomDate27/5/2005Custom Date 2
must be a valid date
txtCustomDate3TitleAnnual financial reviewCustom Date 3 Title
txtCustomDate37/5/2005Custom Date 3
must be a valid date
txtCustomText1AmyCustom Text 1
txtCustomText24 kidsCustom Text 2
txtCustomText3and 1 bunnyCustom Text 3
 
Read More