Overview
Add a contact note via an http form post.
Post Url
https://hyperdrivepro.morethanrewards.com/api/2/AddContactNote.aspx
- SSL is required
Important Note
Submitting a blank field will result in clearing the data for that field out of the database. If you don’t want to change a field, do not submit it with the form.
Form Fields
Field | Max Length* | Required | Notes |
response_type | Yes | Set this field value to json to return results in JSON format | |
accountid | Yes | Must be numeric. Account ID for this account. | |
apikey | Yes | API Key for this account. | |
teammemberid | No | Must be numeric. Team Member ID. Defaults to 0 (Account Owner). | |
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 |
note | Yes | No HTML. Use \n to insert a new line character. | |
pin | No | 0 : Not Pinned (default) 1 : Pin this note (there is maximum number of pinned notes. Pinning a note may unpin an older note.) | |
date | No | Optional Date+Time in the following format: MM/DD/YYYY HH:mm (Use US Central time) To use current server time, leave the date field blank |
* 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> <noteid>15631</noteid> </results>
Sample Failure Message
<?xml version="1.0"?> <results> <error>Authentication failed</error> </results> <?xml version="1.0"?> <results> <error>Add Note failed: Contact not found</error> </results>