AddAppointment

Overview

Create an appointment in the database via an http form post.

URL

POST/api/2/AddAppointment.aspx

Parameters

FieldMax LengthRequiredNotes
response_typefalseDefault results will be returned in XML. Set this field value to json to return results in JSON format
accountidtrueMust be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
teammemberidfalseMust 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. (New in October 2014 Update)
apikeytrueAPI Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
identifymethod1trueValues:
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)
identifyvalue75falseValue changes based on indentifymethod. Must be integer if contactid, otherwise must be an email address on file
description50trueNo HTML
date10trueDate in the following format: MM/DD/YYYY
color2falseUse numeric color codes:
0 or blank: no color – default
1: light blue: rgb(164, 189, 252)
2: teal: rgb(122, 231, 191)
3: purple: rgb(219, 173, 255)
4: orange: rgb(255, 135, 124)
5: yellow: rgb(251, 215, 91)
6: light orange: rgb(255, 184, 120)
7: dark teal: rgb(70, 214, 219)
8: light gray: rgb(225, 225, 225)
9: dark blue: rgb(84, 132, 237)
10: dark green: rgb(81, 183, 73)
11: red: rgb(220, 33, 39)
starttime8trueTime in the following format:
HH:MM AM or HH:MM PM in 15 minute increments
endtime8trueTime in the following format:
HH:MM AM or HH:MM PM in 15 minute increments
details500falseNo HTML