POST 17.0/app/appointments

Description

Creates a new appointment with the passed details

URI Parameters

None.

Details of the appointment to create

NewAppointmentRequest
Name Description Type Additional information
TypeId

integer

Required

Range: inclusive between 1 and 2147483647
ReminderInterval

byte

None.
StartDate

date

Required
EndDate

date

Required
Attendees

Collection of AppointmentAttendee

None.
Properties

Collection of AppointmentProperty

None.
Notes

string

None.
RecurrenceFrequency

byte

None.
RecurrenceEndDate

date

None.

application/json, text/json
Sample: 
{
  "typeId": 1,
  "reminderInterval": 64,
  "startDate": "2025-04-26T18:30",
  "endDate": "2025-04-26T18:30",
  "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
    }
  ],
  "notes": "sample string 5",
  "recurrenceFrequency": 64,
  "recurrenceEndDate": "2025-04-26T18:30"
}

application/x-www-form-urlencoded
Sample:

Sample not available.

Id of the created appointment

NewRecord
Name Description Type Additional information
Id

integer

None.

application/json, text/json
Sample: 
{
  "id": 1
}

application/xml, text/xml
Sample: 
<NewRecord xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
</NewRecord>