Delete Received PhoneChat Bookings

This API operation deletes a completed PhoneChat booking.

URL / Endpoint

POST /v1/PhoneChat/DeleteReceivedBooking

Request

Property	Type	Description
`BookingIDs`	string of comma-seperated integers	Required. One or multiple IDs of PhoneChat Bookings you want to delete.

Prerequisites

This endpoint has a couple of prerequisites which affects the PhoneChat Bookings.

Property	Type	Description
`Status`	string	The Status must be `Rejected`, `Cancelled` or `Confirmed`.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Scopes

This endpoint requires the following scope:

Scope
`account_phonechat_bookings`

Samples

POST method

https://api-sandbox.adultwork.com/v1/PhoneChat/DeleteReceivedBookings
Authorization: bearer {your-access-token}

{ 
    "BookingIDs": "100,101,102"
}

Response

Property	Type	Description
`BookingID`	integer	The ID of the booking.
`Deleted`	boolean	A boolean indicating if this booking was actually deleted or not.
`Message`	string	A message related to the delete action. If the Delete failed, this message will explain why it has failed.

Response Sample

The following example returns a list of both deleted and non-deleted PhoneChat Bookings.

JSON
XML

[
    {
        "BookingID": 101,
        "Deleted": true,
        "Message": "Booking deleted"
    },
    {
        "BookingID": 102,
        "Deleted": false,
        "Message": "The session booking cannot be deleted until it has been marked as complete. The booking needs to be cancelled before it can be deleted."
    }
]

<ArrayOfDeleteBookingOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.PhoneChat.Bookings">
    <DeleteBookingOutput>
        <BookingID>101<BookingID>
        <Deleted>true<Deleted>
        <Message>Booking deleted<Message>
    </DeleteBookingOutput>
    <DeleteBookingOutput>
        <BookingID>102<BookingID>
        <Deleted>false<Deleted>
        <Message>The session booking cannot be deleted until it has been marked as complete. The booking needs to be cancelled before it can be deleted.<Message>
    </DeleteBookingOutput>
</ArrayOfDeleteBookingOutput>