Cancel Booking

POST

/v1/bookings/{uid}/cancel

The Cancel Booking API allows users to cancel an existing booking. By providing the booking uid, the API will update the booking status to “Cancelled”. This action may trigger notifications or other processes depending on the system’s configuration.

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: ********************

Path Params

Body Params application/json

Example

{}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/bookings//cancel' \
--header 'X-Jicoo-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200Success

application/json

Body

Example

{
    "data": {
        "uid": "string",
        "eventTypeId": "string",
        "name": "string",
        "description": "string",
        "status": "request",
        "startedAt": "2019-08-24T14:15:22Z",
        "endedAt": "2019-08-24T14:15:22Z",
        "locationId": "inPerson",
        "url": "string",
        "phoneNumber": "string",
        "address": "string",
        "customLocation": "string",
        "access": "string",
        "timeZone": "string",
        "priority": "low",
        "cancelReason": "string",
        "cancelledAt": "2019-08-24T14:15:22Z",
        "cancelledBy": "host",
        "hosts": [
            {
                "userId": "string",
                "role": "admin"
            }
        ],
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
    }
}

🟠422Parameter Error

Modified at 2024-08-28 09:21:11

Get Booking

Reschedule Booking