POST api/Scheduler/UpdateAppointment

Request Information

URI Parameters

None.

Body Parameters

SaveAppointment
NameDescriptionTypeAdditional information
AppointmentTimeZone

string

None.

AppointmentTypeId

integer

None.

AppointmentCategoryId

integer

None.

StartDateTime

date

None.

EndDateTime

date

None.

StaffTypeIds

string

None.

TeamIds

string

None.

LocationIds

string

None.

Subject

string

None.

CompanyId

integer

None.

Duration

integer

None.

UserId

integer

None.

ShowTime

integer

None.

StaffIds

string

None.

ClientIds

string

None.

AppointmentStatusIds

Collection of ClientStatus

None.

AppointmentStatusId

integer

None.

Notes

string

None.

ServiceIds

string

None.

CancelDate

date

None.

ReasonId

integer

None.

AppointmentId

integer

None.

BlockTimeId

integer

None.

DeleteClientIds

string

None.

IsRecurrence

boolean

None.

RecurranceId

integer

None.

Recurrances

Recurrance

None.

RescheduleID

integer

None.

Type

integer

None.

EditAll

boolean

None.

HospitalMedicalProviderID

integer

None.

ExternalProviderGroupId

integer

None.

ExternalProviderId

integer

None.

GroupID

integer

None.

FollowupAppointmentRequestId

integer

None.

FirstOffered

boolean

None.

IsOffSiteAppointment

boolean

None.

offsiteDuration

integer

None.

TraveloffsiteappID

integer

None.

IsbackFacility

boolean

None.

FacilityDuration

integer

None.

TravelFacilityappID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AppointmentTimeZone": "sample string 1",
  "AppointmentTypeId": 2,
  "AppointmentCategoryId": 1,
  "StartDateTime": "2026-04-17T13:01:10.126047+00:00",
  "EndDateTime": "2026-04-17T13:01:10.126047+00:00",
  "StaffTypeIds": "sample string 3",
  "TeamIds": "sample string 4",
  "LocationIds": "sample string 5",
  "Subject": "sample string 6",
  "CompanyId": 7,
  "Duration": 8,
  "UserId": 9,
  "ShowTime": 10,
  "StaffIds": "sample string 11",
  "ClientIds": "sample string 12",
  "AppointmentStatusIds": [
    {
      "Value": 1,
      "ClientId": 2
    },
    {
      "Value": 1,
      "ClientId": 2
    }
  ],
  "AppointmentStatusId": 13,
  "Notes": "sample string 14",
  "ServiceIds": "sample string 15",
  "CancelDate": "2026-04-17T13:01:10.1270448+00:00",
  "ReasonId": 1,
  "AppointmentId": 16,
  "BlockTimeId": 1,
  "DeleteClientIds": "sample string 17",
  "IsRecurrence": true,
  "RecurranceId": 1,
  "Recurrances": {
    "RecurrenceType": "sample string 1",
    "Interval": 2,
    "Start": "2026-04-17T13:01:10.1280507+00:00",
    "EndsOn_Never": true,
    "EndsOn_Count": true,
    "EndsOn_Count_Input": 1,
    "EndsOn_Until": true,
    "EndsOn_Until_Input": "2026-04-17T13:01:10.1280507+00:00",
    "DayOfMonthRepeat": true,
    "DayOfWeekRepeat": true,
    "DayOfWeekMonday": true,
    "DayOfWeekTuesday": true,
    "DayOfWeekWednesday": true,
    "DayOfWeekThursday": true,
    "DayOfWeekFriday": true,
    "DayOfWeekSaturday": true,
    "DayOfWeekSunday": true
  },
  "RescheduleID": 18,
  "Type": 19,
  "EditAll": true,
  "HospitalMedicalProviderID": 1,
  "ExternalProviderGroupId": 1,
  "ExternalProviderId": 1,
  "GroupID": 1,
  "FollowupAppointmentRequestId": 1,
  "FirstOffered": true,
  "IsOffSiteAppointment": true,
  "offsiteDuration": 1,
  "TraveloffsiteappID": 1,
  "IsbackFacility": true,
  "FacilityDuration": 1,
  "TravelFacilityappID": 1
}

application/xml, text/xml

Sample:
<SaveAppointment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.Cx360.WebAPI.Models.Scheduler">
  <AppointmentCategoryId>1</AppointmentCategoryId>
  <AppointmentId>16</AppointmentId>
  <AppointmentStatusId>13</AppointmentStatusId>
  <AppointmentStatusIds>
    <ClientStatus>
      <ClientId>2</ClientId>
      <Value>1</Value>
    </ClientStatus>
    <ClientStatus>
      <ClientId>2</ClientId>
      <Value>1</Value>
    </ClientStatus>
  </AppointmentStatusIds>
  <AppointmentTimeZone>sample string 1</AppointmentTimeZone>
  <AppointmentTypeId>2</AppointmentTypeId>
  <BlockTimeId>1</BlockTimeId>
  <CancelDate>2026-04-17T13:01:10.1270448+00:00</CancelDate>
  <ClientIds>sample string 12</ClientIds>
  <CompanyId>7</CompanyId>
  <DeleteClientIds>sample string 17</DeleteClientIds>
  <Duration>8</Duration>
  <EditAll>true</EditAll>
  <EndDateTime>2026-04-17T13:01:10.126047+00:00</EndDateTime>
  <ExternalProviderGroupId>1</ExternalProviderGroupId>
  <ExternalProviderId>1</ExternalProviderId>
  <FacilityDuration>1</FacilityDuration>
  <FirstOffered>true</FirstOffered>
  <FollowupAppointmentRequestId>1</FollowupAppointmentRequestId>
  <GroupID>1</GroupID>
  <HospitalMedicalProviderID>1</HospitalMedicalProviderID>
  <IsOffSiteAppointment>true</IsOffSiteAppointment>
  <IsRecurrence>true</IsRecurrence>
  <IsbackFacility>true</IsbackFacility>
  <LocationIds>sample string 5</LocationIds>
  <Notes>sample string 14</Notes>
  <ReasonId>1</ReasonId>
  <RecurranceId>1</RecurranceId>
  <Recurrances>
    <DayOfMonthRepeat>true</DayOfMonthRepeat>
    <DayOfWeekFriday>true</DayOfWeekFriday>
    <DayOfWeekMonday>true</DayOfWeekMonday>
    <DayOfWeekRepeat>true</DayOfWeekRepeat>
    <DayOfWeekSaturday>true</DayOfWeekSaturday>
    <DayOfWeekSunday>true</DayOfWeekSunday>
    <DayOfWeekThursday>true</DayOfWeekThursday>
    <DayOfWeekTuesday>true</DayOfWeekTuesday>
    <DayOfWeekWednesday>true</DayOfWeekWednesday>
    <EndsOn_Count>true</EndsOn_Count>
    <EndsOn_Count_Input>1</EndsOn_Count_Input>
    <EndsOn_Never>true</EndsOn_Never>
    <EndsOn_Until>true</EndsOn_Until>
    <EndsOn_Until_Input>2026-04-17T13:01:10.1280507+00:00</EndsOn_Until_Input>
    <Interval>2</Interval>
    <RecurrenceType>sample string 1</RecurrenceType>
    <Start>2026-04-17T13:01:10.1280507+00:00</Start>
  </Recurrances>
  <RescheduleID>18</RescheduleID>
  <ServiceIds>sample string 15</ServiceIds>
  <ShowTime>10</ShowTime>
  <StaffIds>sample string 11</StaffIds>
  <StaffTypeIds>sample string 3</StaffTypeIds>
  <StartDateTime>2026-04-17T13:01:10.126047+00:00</StartDateTime>
  <Subject>sample string 6</Subject>
  <TeamIds>sample string 4</TeamIds>
  <TravelFacilityappID>1</TravelFacilityappID>
  <TraveloffsiteappID>1</TraveloffsiteappID>
  <Type>19</Type>
  <UserId>9</UserId>
  <offsiteDuration>1</offsiteDuration>
</SaveAppointment>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SaveAppointment'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />