POST Agents/Appointment/CleanUpBookingDeletedWithUpdateMode

Some tooltip text!

• 1 minute to read

 • 1 minute to read

POST /api/v1/Agents/Appointment/CleanUpBookingDeletedWithUpdateMode

Deletes all appointments(within the appointmentIds array) with status BookingDeleted.

All appointments in the list will be deleted using the same recurrence update mode.

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

POST /api/v1/Agents/Appointment/CleanUpBookingDeletedWithUpdateMode?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept	Content-type(s) you would like the response in:
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

AppointmentIds, UpdateMode

Property Name	Type	Description
AppointmentIds	Array
UpdateMode	String

Response:

No Content

Response	Description
204	No Content

Response body: TimeZoneData

Sample request

POST /api/v1/Agents/Appointment/CleanUpBookingDeletedWithUpdateMode
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "AppointmentIds": [
    12,
    799
  ],
  "UpdateMode": "OnlyThis"
}

Sample response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8

null