HYPER DRIVE PRO CRM - API REFERENCE
CONTACT FUNCTIONS / UPDATECONTACT
For more information on our products and services please visit:
http://HyperDriveCRM.com | http://RiderRewards.com | http://MoreThanRewards.com
Need help integrating with our products and services?
Give us a call at 414-326-4100 or email Support@MoreThanRewards.com/
Ask to speak to Jason Brethorst regarding API partnerships and integrations.
WE HAVE AN API FOR JUST ABOUT ANYTHING
All More Than Rewards products are built using REST API architecture, therefore you'll be able to do ANYTHING within our products and services a REST call, you just need to know which one to use. If there is something that your trying to do but are not clear just give Jason a call via his direct number at 414-467-6624 or speak to your account manager to learn more.
TEST SANDBOX API KEYSSANDBOX ACCOUNT ID : 2175 SANDBOX API KEY : 1E7F03ACAEDE1CAD0C567DC14319821C |
UpdateContact
This API end point will update a contact to the Hyper Drive Pro CRM system by More Than Rewards. For more information on HyperDrive CRM. Adds a contact to the database via an https form post. A successful post will return a success message and the contactid for the new contact.
Post Url
https://hyperdrivepro.morethanrewards.com/api/2/UpdateContact.aspx
* SSL is requred
BE CAREFUL WHEN UPDATING - DON'T MESS UP THE DEALERS DATA!
Submitting a blank field (for all non-required fields) will result in clearing the data for that field out of the database.
If you don’t want to update the fields data DO NOT include it in the form POST!
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 (as of Jan 1st 2018 we are disconnecting XML support, and moving to 100% json support instead, please use json when possible) | |
accountid | Yes | Must be numeric. Account ID for this account. | |
apikey | Yes | API Key for this account. | |
identifymethod | 1 | Yes | Values: 1 : By contactid (It’s recommended that you use this method and store our contactid in your system) 2 : By primary email on file. If there are multiple matches for the email address, we will choose the first one (by add date) 3: By email or other email on file. If there are multiple matches for the email address, we will choose the first one (by add date) |
identifyvalue | 75 | Yes | Value changes based on indentifymethod. Must be integer if contactid, otherwise must be an email address on file |
firstname | 50 | No | Database requires both first and last name |
lastname | 50 | No | Database requires both first and last name |
birthday | 10 | No | Birthday year is optional. Use only formats MM/DD or MM/DD/YYYY. Zero pad leading digits, so month and day are always 2 digits. January 5th is 01/05. |
otherfirstname | 50 | No | |
otherlastname | 50 | No | |
otherbirthday | 10 | No | Birthday year is optional. Use only formats MM/DD or MM/DD/YYYY. Zero pad leading digits, so month and day are always 2 digits. January 5th is 01/05. |
company | 50 | No | |
address | 50 | No | |
city | 50 | No | |
state | 20 | No | Recommended that this be the 2 digit state code for US addresses |
postalcode | 20 | No | |
phone1 | 20 | No | Will automatically be formatted to (xxx) xxx-xxxx |
phone1note | 20 | No | Recommended that description is used if known (work, home, mobile, etc…) |
phone2 | 20 | No | Will automatically be formatted to (xxx) xxx-xxxx |
phone2note | 20 | No | |
phone3 | 20 | No | Will automatically be formatted to (xxx) xxx-xxxx |
phone3note | 20 | No | |
phone4 | 20 | No | Will automatically be formatted to (xxx) xxx-xxxx |
phone4note | 20 | No | |
fax | 20 | No | Will automatically be formatted to (xxx) xxx-xxxx |
email | 75 | No | |
custom1 | 50 | No | Please use this field for the "Rewards Number" only. |
custom2 | 50 | No | Please use this field for the "Deal - Value" only. |
custom3 | 50 | No | Please use this field for the "Deal Inventory - Updated" only. |
custom4 | 50 | No | Please use this field for the "Trade - Value" only. |
custom5 | 50 | No | Please use this field for the "Trade - VIN" only. |
custom6 | 50 | No | Please use this field for the "Trade - Make" only. |
custom7 | 50 | No | Please use this field for the "Trade - Model" only. |
custom8 | 50 | No | Please use this field for the "Trade - Year" only. |
custom9 | 50 | No | Please use this field for the "Trade - Color" only. |
custom10 | 50 | No | Please use this field for the "Trade - Odometer" only. |
custom11 | 50 | No | Please use this field for the "Deal - Stock Number" only. |
custom12 | 50 | No | Please use this field for the "Deal - VIN" only. |
custom13 | 50 | No | Please use this field for the "Deal - VIN" only. |
custom14 | 50 | No | Please use this field for the "Deal - Model" only. |
custom15 | 50 | No | Please use this field for the "Deal - Year" only. |
custom16 | 50 | No | Please use this field for the "Deal - Color" only. |
custom17 | 50 | No | Please use this field for the "Deal - Odometer" only. |
custom18 | 50 | No | Please use this field for the "Deal - New or Used" only. |
custom19 | 50 | No | Please use this field for the "Deal - Create Date" only. |
custom20 | 50 | No | Please use this field for the "Deal - Close Date" only. |
memo | 50 | No | Brief memo for contact. This is not a note, but a brief memo that shows up on the contact’s page. Recommended less than 100 characters. |
category | 50 | No | Must match the name of an existing Category exactly. Any mismatch will result in the category not being assigned. |
category2 | 50 | No | Must match the name of an existing Category2 exactly. Any mismatch will result in the category2 not being assigned. (This is the customizable contact) |
source | 50 | No | Must match the name of an existing Source exactly. Any mismatch will result in the source not being assigned. |
othersystemid | 32 | No | For tracking the ID of this contact in another system |
* 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> <contactid>15631</contactid> </results>
Sample Failure Message
<?xml version="1.0"?> <results> <error>Authentication failed</error> </results> <?xml version="1.0"?> <results> <error>Update failed: Contact not found</error> </results>