Cancel Booking - Automate.ax

square.cancelBooking cancels an existing booking.

Example

automations/square-cancel-booking.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Cancel Square Booking", () => {
  onDashboardRun({ title: "Cancel Square Booking" })

  square.cancelBooking({
    bookingId: "booking_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires APPOINTMENTS_WRITE.

Field	Type	Required	Default	Description
`bookingId`	`string`	Yes	—	The ID of the Booking object representing the to-be-cancelled booking.
`idempotencyKey`	`string \| null`	No	—	A unique key to make this request an idempotent operation.
`bookingVersion`	`number \| null`	No	—	The revision number for the booking used for optimistic concurrency.

Use the official CancelBooking reference for provider field semantics and limits.

Output

Returns the official Square.CancelBookingResponse response as a codec-safe object. Square integer money amounts remain bigint values.