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

Path Params

uid

string

required

name

string

optional

description

string | null

optional

timeZone

string

optional

startedAt

string <date-time>

optional

endedAt

string <date-time>

optional

hosts

array [object {2}]

optional

userId

string

required

role

enum<string>

required

Allowed values:

admineditorviewer

priority

optional

Any of

string

null

Allowed values:

lowmiddlehigh

updateMessage

string

optional

<= 2000 characters

isSendUpdates

boolean

optional

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

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

data

#/definitions/1332902

required

Not configured

Last modified: 3 months ago