Appointment7

Appointment Availability1

Booking4

Branch1

Branch Service4

Branch WorkTimeTable1

Break5

CheckIn1

Client8

Client Course3

Client Credit Account Transaction1

ClientCategory2

Course1

CSV Export Job2

Deposit1

Inventory Transaction1

Lead4

Loyalty Points1

Machine2

PaymentType2

Product1

Purchase1

Review2

Room2

SaleFee3

Service Category1

Service Package1

Service Special Offer1

Staff3

Staff WorkTimeTable1

Stock1

Tax2

Till2

Till Session1

Time Off Policy2

Voucher4

Booking

Activate a booking

Activate a reserved booking with optional deposit amount provided

post/api/business/{businessId}/branch/{branchId}/booking/{bookingId}/activate

Request

Base URL
http://api-gateway-eu.phorest.com/third-party-api-server
Auth
HTTP basic
TypeScript
https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/booking/:bookingId/activate/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

businessIdstring required

branchIdstring required

bookingIdstring required

Request body

depositAmountnumber

The deposit amount paid by the client to confirm the booking. Deposit can only be set when activating an already reserved booking. When creating a new booking with state ACTIVE deposit is set to 0 by default.

Example request

{
  "depositAmount": 1.5
}

Response

Booking activated successfully

Changes

No recorded changes to this operation across all 2 revisions of this API.