Overview
Add a special event for a specified contact via an http form post.
Post Url
https://hyperdrivepro.morethanrewards.com/api/2/AddContactSpecialEvent.aspx
- SSL is required
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. | |
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 |
occasion | 1 | yes | Possible Values: 1: Birthday, 2: Anniversary, 3: Other |
description | 50 | yes | |
addresslabel | 50 | yes | |
date | 10 | yes | 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. |
* 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" encoding="UTF-8"?> <results> <specialevents> <specialevent> <occasion>Anniversary</occasion> <description>Wedding Anniversary</description> <addresslabel>Todd Smith</addresslabel> <date>06/16/2001</date> </specialevent> </specialevents> </results>
Sample Failure Message
<?xml version="1.0"?> <results> <error>Authentication failed</error> </results> <?xml version="1.0"?> <results> <error>Contact not found</error> </results>