UpdateAppointment

Overview

Update an existing appointment via an http form post.

URL

POST/api/2/UpdateAppointment/       or legacy URL at  /api/2/UpdateAppointment.aspx

form-data 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
apikeytrueAPI Key for this account.
Found in Settings > API Settings or for White Label CRM in the Admin control panel
appointmentidtrueID of appointment to update
identifymethod1falseMethod to identify and update the contact associated with this appointment. Values:
0 : Remove contact association (set to no 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 identifymethod. Must be integer if contactid (method 1), otherwise must be an email address on file (methods 2 & 3). Not required if identifymethod is 0.
teammemberidfalseMust be numeric. Team Member ID to assign this appointment to.
description50falseShort description of the appointment
datefalseUS Date format
mm/dd/yyyy
starttimefalseStart time in 15 minute increments
Examples: 9:00 AM, 2:15 PM
Must end in :00, :15, :30, or :45
endtimefalseEnd time in 15 minute increments
Examples: 10:00 AM, 3:30 PM
Must end in :00, :15, :30, or :45
Must be after starttime
detailsfalseDetailed notes about the appointment
colorfalseColor code (numeric 0-11):
0: No Color (removes color)
1-11: Various colors