Update Booking

PATCH

/v1/bookings/{uid}

The Update Booking API provides users with the ability to modify specific details of an existing booking. By passing the uid along with the fields to be updated, this API allows changes such as updating name, description, date and time, hosts or additional infomations. The system only updates the specified fields, leaving the rest of the booking information unchanged.

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

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

Path Params

Body Params application/json

Example

{
    "name": "string",
    "description": "string",
    "timeZone": "string",
    "startedAt": "2019-08-24T14:15:22Z",
    "endedAt": "2019-08-24T14:15:22Z",
    "hosts": [
        {
            "userId": "string",
            "role": "admin"
        }
    ],
    "priority": "low",
    "updateMessage": "string",
    "isSendUpdates": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/v1/bookings/' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw '{
    "name": "string",
    "description": "string",
    "timeZone": "string",
    "startedAt": "2019-08-24T14:15:22Z",
    "endedAt": "2019-08-24T14:15:22Z",
    "hosts": [
        {
            "userId": "string",
            "role": "admin"
        }
    ],
    "priority": "low",
    "updateMessage": "string",
    "isSendUpdates": true
}'

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"
    }
}

Modified at 2024-08-28 09:25:07

Create Booking

Get Booking Contacts