Skip to content

update_cancelation_policies

Update one or more cancelation policies. Required field: cancelation policy ID. Optional fields: name, cancelation fee percentage (0-100, not currently used: no charge or refund is calculated from it), and cool-off period (length, length unit HOURS or DAYS, type BOOKING_CREATION or BOOKING_CONFIRMATION). Pass coolOff: null to clear the cool-off period. At least one field to update must be provided.

Parameter Type Required Description
cancelationPolicies UpdateCancelationPolicyInput[] Yes Array of cancelation policies to update - UpdateCancelationPolicyInput
Field Type Required Description
cancelationPolicyId string Yes The ID of the cancelation policy to update
name string No New name for the cancelation policy. Must be unique within the workspace (max 255 characters).
cancelationFeePercentage number No The cancelation fee percentage (0-100). Not currently used: it is stored with the policy and on each booking, but no charge or refund is calculated from it.
coolOff CoolOff | null No Cool-off period configuration. Pass null to clear the cool-off period. - CoolOff
Field Type Required Description
length number Yes Cool-off period length, must be greater than 0
lengthUnit CoolOffLengthUnit Yes CoolOffLengthUnit
type CoolOffFrom Yes CoolOffFrom
Value Description
HOURS Cool-off length is measured in hours
DAYS Cool-off length is measured in days
Value Description
BOOKING_CREATION Cool-off period starts when the booking is created
BOOKING_CONFIRMATION Cool-off period starts when the booking is confirmed
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display