Overview
Create an appointment in the database via an http form post.
Post Url
https://hyperdrivepro.morethanrewards.com/api/2/AddAppointment.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. | |
teammemberid | No | Must be numeric. See list of team members ID’s using the GetTeamMembers function. Leaving this field blank will add this contact to the team member which the contact belongs. | |
apikey | Yes | API Key for this account. | |
identifymethod | 1 | Yes | Values:0 : Do not link this appointment to a contact 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 | No | Value changes based on indentifymethod. Must be integer if contactid, otherwise must be an email address on file |
description | 50 | Yes | No HTML |
date | 10 | Yes | Date in the following format: MM/DD/YYYY |
starttime | 8 | Yes | Time in the following format: HH:MM AM or HH:MM PM in 15 minute increments |
endtime | 8 | Yes | Time in the following format: HH:MM AM or HH:MM PM in 15 minute increments |
details | 500 | No | No HTML |
* 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> <appointmentid>15631</appointmentid> </results>
Sample Failure Message
<?xml version="1.0"?> <results> <error>Authentication failed</error> </results> <?xml version="1.0"?> <results> <error>Add Appointment failed: Contact not found</error> </results>