Overview
Get special events for a specified contact via an http form post.
Post Url
https://www.allclients.com/api/2/GetContactSpecialEvents.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
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 | |
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
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) * (asterisk) : All contacts in account |
identifyvalue | 75 | Conditional | Value changes based on indentifymethod. Must be integer if contactid, otherwise must be an email address on file.
Not needed for “*” identifymethod |
* 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>