POST api/appointments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
subscription_id	globally unique identifier	None.
owner_id	string	None.
organiser	string	None.
title	string	None.
appointment_type_id	globally unique identifier	None.
appointment_type	string	None.
attendees	Collection of SelectListItem	None.
attendees_as_string	string	None.
start	date	None.
start_timezone_id	string	None.
end	date	None.
end_timezone_id	string	None.
is_all_day	boolean	None.
reminder_minutes_before_start	integer	None.
priority	string	None.
location	string	None.
notes	string	None.
send_invite	boolean	None.
id	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "subscription_id": "a67914b0-a6c7-4c0f-9d9f-f1b940756433",
  "owner_id": "sample string 1",
  "organiser": "sample string 2",
  "title": "sample string 3",
  "appointment_type_id": "1dcc498e-dc51-4077-bf2b-1454b83dd5a7",
  "appointment_type": "sample string 4",
  "attendees": [
    {
      "value": "sample string 1",
      "text": "sample string 2"
    },
    {
      "value": "sample string 1",
      "text": "sample string 2"
    }
  ],
  "attendees_as_string": "sample string 5",
  "start": "2026-04-10T20:12:01.8704109+08:00",
  "start_timezone_id": "sample string 7",
  "end": "2026-04-10T20:12:01.8704109+08:00",
  "end_timezone_id": "sample string 9",
  "is_all_day": true,
  "reminder_minutes_before_start": 1,
  "priority": "sample string 11",
  "location": "sample string 12",
  "notes": "sample string 13",
  "send_invite": true,
  "id": "237f30dc-7003-4121-86d3-d420ce6838ea"
}

application/xml, text/xml

Sample:

<AppointmentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models">
  <Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">237f30dc-7003-4121-86d3-d420ce6838ea</Id>
  <AppointmentType>sample string 4</AppointmentType>
  <AppointmentTypeId>1dcc498e-dc51-4077-bf2b-1454b83dd5a7</AppointmentTypeId>
  <Attendees xmlns:d2p1="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">
    <d2p1:SelectListItem>
      <d2p1:Text>sample string 2</d2p1:Text>
      <d2p1:Value>sample string 1</d2p1:Value>
    </d2p1:SelectListItem>
    <d2p1:SelectListItem>
      <d2p1:Text>sample string 2</d2p1:Text>
      <d2p1:Value>sample string 1</d2p1:Value>
    </d2p1:SelectListItem>
  </Attendees>
  <AttendeesAsString>sample string 5</AttendeesAsString>
  <End>2026-04-10T20:12:01.8704109+08:00</End>
  <EndTimeZoneId>sample string 9</EndTimeZoneId>
  <IsAllDay>true</IsAllDay>
  <Location>sample string 12</Location>
  <Notes>sample string 13</Notes>
  <Organiser>sample string 2</Organiser>
  <OwnerId>sample string 1</OwnerId>
  <Priority>sample string 11</Priority>
  <ReminderMinutesBeforeStart>1</ReminderMinutesBeforeStart>
  <SendInvite>true</SendInvite>
  <Start>2026-04-10T20:12:01.8704109+08:00</Start>
  <StartTimeZoneId>sample string 7</StartTimeZoneId>
  <SubscriptionId>a67914b0-a6c7-4c0f-9d9f-f1b940756433</SubscriptionId>
  <Title>sample string 3</Title>
</AppointmentModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.