PUT 17.0/app/appointments/{id}

Description

Updates an appointment

URI Parameters
Name Description Type Additional information
id

Id of the appointment to retrieve details for

 integer

Required

Details of the appointment to update

Appointment
Name Description Type Additional information
Id

integer

None.
StartDate

date

None.
EndDate

date

None.
TypeId

integer

None.
ReminderInterval

byte

None.
Notes

string

None.
Attendees

Collection of AppointmentAttendee

None.
Properties

Collection of AppointmentProperty

None.
ConfirmedDate

date

None.
NoShow

boolean

None.
CancelledDate

date

None.
ApplicantFollowedUpDate

date

None.
OwnerFollowedUpDate

date

None.
AssignedUserId

integer

None.
SiteId

integer

None.
FollowUpDueDate

date

None.

application/json, text/json
Sample: 
{
  "id": 1,
  "startDate": "2025-01-09T20:16",
  "endDate": "2025-01-09T20:16",
  "typeId": 4,
  "reminderInterval": 64,
  "notes": "sample string 6",
  "attendees": [
    {
      "contactId": 1,
      "name": "sample string 2",
      "confirmed": true
    },
    {
      "contactId": 1,
      "name": "sample string 2",
      "confirmed": true
    }
  ],
  "properties": [
    {
      "propertyId": 1,
      "address": "sample string 2",
      "confirmed": true
    },
    {
      "propertyId": 1,
      "address": "sample string 2",
      "confirmed": true
    }
  ],
  "confirmedDate": "2025-01-09T20:16",
  "noShow": true,
  "cancelledDate": "2025-01-09T20:16",
  "applicantFollowedUpDate": "2025-01-09T20:16",
  "ownerFollowedUpDate": "2025-01-09T20:16",
  "assignedUserId": 12,
  "siteId": 13,
  "followUpDueDate": "2025-01-09T20:16"
}

application/xml, text/xml
Sample: 
<Appointment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <StartDate>2025-01-09T20:16:09.34452+00:00</StartDate>
  <EndDate>2025-01-09T20:16:09.34452+00:00</EndDate>
  <TypeId>4</TypeId>
  <ReminderInterval>64</ReminderInterval>
  <Notes>sample string 6</Notes>
  <Attendees>
    <AppointmentAttendee>
      <ContactId>1</ContactId>
      <Name>sample string 2</Name>
      <Confirmed>true</Confirmed>
    </AppointmentAttendee>
    <AppointmentAttendee>
      <ContactId>1</ContactId>
      <Name>sample string 2</Name>
      <Confirmed>true</Confirmed>
    </AppointmentAttendee>
  </Attendees>
  <Properties>
    <AppointmentProperty>
      <PropertyId>1</PropertyId>
      <Address>sample string 2</Address>
      <Confirmed>true</Confirmed>
    </AppointmentProperty>
    <AppointmentProperty>
      <PropertyId>1</PropertyId>
      <Address>sample string 2</Address>
      <Confirmed>true</Confirmed>
    </AppointmentProperty>
  </Properties>
  <ConfirmedDate>2025-01-09T20:16:09.34452+00:00</ConfirmedDate>
  <NoShow>true</NoShow>
  <CancelledDate>2025-01-09T20:16:09.34452+00:00</CancelledDate>
  <ApplicantFollowedUpDate>2025-01-09T20:16:09.34452+00:00</ApplicantFollowedUpDate>
  <OwnerFollowedUpDate>2025-01-09T20:16:09.34452+00:00</OwnerFollowedUpDate>
  <AssignedUserId>12</AssignedUserId>
  <SiteId>13</SiteId>
  <FollowUpDueDate>2025-01-09T20:16:09.34452+00:00</FollowUpDueDate>
</Appointment>

application/x-www-form-urlencoded
Sample:

Sample not available.

None.

None.