Skip to main content
PATCH
Update smart group rules

Path Parameters

barberId
string
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

groupId
enum<string>
required
Available options:
active,
lost,
risky,
new

Body

application/merge-patch+json

Representation used to patch client group rules using the JSON Merge Patch format and processing rules.

autoConfirm
boolean | null

Whether appointments are automatically confirmed for this group.

requireCardOnFile
boolean | null

Whether a card on file is required for this group.

sameDayBookingNotice
string<duration> | null

Minimum notice required for same-day bookings.

bookingWindow
string<duration> | null

How far ahead of today a client in this group may book. Null means no advance limit. Counted in whole days, so P14D and P14DT12H both allow the same fourteen days, and the shortest window we accept is P1D. Calendar months and years (P1M, P1Y) are not accepted. Their length is not a fixed number of seconds.

depositRequired
object | null

Deposit requirements for this group.

lateCancelation
object | null

Late cancelation policy settings.

noShowFee
object | null

No-show fee policy settings.

cardAuthorization
object | null

Card authorization policy settings for this group. This is required when prePaymentStrategy is set to authorization. Guile's booking settings offer a fixed one-dollar card check or a full-subtotal hold, placed at the configured time before appointment start. The duration is the server-owned scheduling dial; if its run time has passed, authorization starts when the booking becomes confirmed.

cardDeposit
object | null

Legacy card-deposit settings retained for compatible reads and writes. Guile treats this amount as an uncaptured authorization hold and never captures it at booking. New clients use cardAuthorization.

prePaymentStrategy
enum<string> | null

The pre-payment strategy for this group. Determines how payment is collected or held when a client books.

Available options:
none,
deposit,
authorization

Response

Ok. The operation succeeded.

Rules for a client group.

autoConfirm
boolean
required

Whether appointments are automatically confirmed for this group.

requireCardOnFile
boolean
required

Whether a card on file is required for this group.

sameDayBookingNotice
string<duration>
required

Minimum notice required for same-day bookings.

bookingWindow
string<duration> | null
required

How far ahead of today a client in this group may book. Null means no advance limit. Counted in whole days, so P14D and P14DT12H both allow the same fourteen days, and the shortest window we accept is P1D. Calendar months and years (P1M, P1Y) are not accepted. Their length is not a fixed number of seconds.

depositRequired
object
required

Deposit requirements for this group.

lateCancelation
object
required

Late cancelation policy settings.

noShowFee
object
required

No-show fee policy settings.

prePaymentStrategy
enum<string>
required

The pre-payment strategy for this group. Determines how payment is collected or held when a client books.

Available options:
none,
deposit,
authorization
cardAuthorization
object

Card authorization policy settings for this group. This is required when prePaymentStrategy is set to authorization. Guile's booking settings offer a fixed one-dollar card check or a full-subtotal hold, placed at the configured time before appointment start. The duration is the server-owned scheduling dial; if its run time has passed, authorization starts when the booking becomes confirmed.

cardDeposit
object

Legacy card-deposit settings retained for compatible reads and writes. Guile treats this amount as an uncaptured authorization hold and never captures it at booking. New clients use cardAuthorization.