POST api/appointment/suggest

Auto-picks attendees and the next available appointment slot given the parameters in the request. Processes this appointment API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

An appointment suggest request containing information about the desired appointment.

RequestAppointmentQueryDataContract

Name	Description	Type	Additional information
AppointmentType	The appointment type value.	EnumDataContract	None.
RoleIds	The unique identifiers of the related role resources.	Collection of integer	None.
Location	The location value.	PointDataContract	None.
Availability	The collection of availability.	Collection of TimeRangeDataContract	None.
PreferredPersonId	The unique identifier of the related preferred person resource.	integer	None.
PreferredTeamGroupId	The unique identifier of the related preferred team group resource.	integer	None.
OtherRequiredPeople	The collection of other required people.	Collection of integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "AppointmentType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "RoleIds": [
    1,
    2
  ],
  "Location": {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Altitude": 3.1,
    "Order": 4,
    "Id": 5
  },
  "Availability": [
    {
      "Start": "2026-08-05T00:19:55.5660475Z",
      "End": "2026-08-05T00:19:55.5660475Z"
    },
    {
      "Start": "2026-08-05T00:19:55.5660475Z",
      "End": "2026-08-05T00:19:55.5660475Z"
    }
  ],
  "PreferredPersonId": 1,
  "PreferredTeamGroupId": 1,
  "OtherRequiredPeople": [
    1,
    2
  ]
}

Response Information

Resource Description

A data contract that represents a suggested time. The Availability property will be null if there is no suitable availability

RequestAppointmentQueryResponseDataContract

Name	Description	Type	Additional information
Availability	The availability value.	TimeRangeDataContract	None.
AutomaticallySelectedPeople	The collection of automatically selected people.	Collection of integer	None.
RequiredPeople	The collection of required people.	Collection of integer	None.
TeamId	The unique identifier of the related team resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Availability": {
    "Start": "2026-08-05T00:19:55.5816764Z",
    "End": "2026-08-05T00:19:55.5816764Z"
  },
  "AutomaticallySelectedPeople": [
    1,
    2
  ],
  "RequiredPeople": [
    1,
    2
  ],
  "TeamId": 1
}