Update smart group rules

Path Parameters

barberId

string<uuid>

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

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

enum<string>

Maximum advance booking window allowed.

Available options:

noLimit,

oneWeek,

twoWeeks,

threeWeeks,

oneMonth,

twoMonths,

threeMonths

depositRequired

object

Deposit requirements for this group. Settings for deposit requirements for a client group.

Show child attributes

depositRequired.type

enum<string>

The type of deposit required.

Available options:

none,

fixed,

percentage

depositRequired.fixed

string<decimal>

The amount required for a fixed deposit. This field is required if type is fixed. A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision.

Example:

"456.78"

depositRequired.percentage

integer<int8> | null

The percentage required for a percentage deposit. This field is required if type is percentage.

Required range: 0 <= x <= 100

lateCancelation

object

Late cancelation policy settings. Late cancelation policy settings for a client group.

Show child attributes

lateCancelation.cancellationWindow

string<duration>

Time window before appointment when cancelation is considered late.

lateCancelation.fee

object

Fee policy for late cancelations.

Show child attributes

lateCancelation.fee.type

enum<string>

The type of fee.

Available options:

none,

fixed,

percentage

lateCancelation.fee.fixed

string<decimal>

The amount for a fixed fee. This field is required if type is fixed. A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision.

Example:

"456.78"

lateCancelation.fee.percentage

integer<int8> | null

The percentage for a percentage fee. This field is required if type is percentage.

Required range: 0 <= x <= 100

noShowFee

object

No-show fee policy settings. Settings for fees for a client group.

Show child attributes

noShowFee.type

enum<string>

The type of fee.

Available options:

none,

fixed,

percentage

noShowFee.fixed

string<decimal>

Example:

"456.78"

noShowFee.percentage

integer<int8> | null

The percentage for a percentage fee. This field is required if type is percentage.

Required range: 0 <= x <= 100

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

enum<string>

required

Maximum advance booking window allowed.

Available options:

noLimit,

oneWeek,

twoWeeks,

threeWeeks,

oneMonth,

twoMonths,

threeMonths

depositRequired

object

required

Deposit requirements for this group.

Show child attributes

depositRequired.type

enum<string>

required

The type of deposit required.

Available options:

none,

fixed,

percentage

depositRequired.fixed

string<decimal>

The amount required for a fixed deposit. This field is required if type is fixed.

Example:

"456.78"

depositRequired.percentage

integer<int8>

The percentage required for a percentage deposit. This field is required if type is percentage.

Required range: 0 <= x <= 100

lateCancelation

object

required

Late cancelation policy settings.

Show child attributes

lateCancelation.cancellationWindow

string<duration>

required

Time window before appointment when cancelation is considered late.

lateCancelation.fee

object

required

Fee policy for late cancelations.

Show child attributes

lateCancelation.fee.type

enum<string>

required

The type of fee.

Available options:

none,

fixed,

percentage

lateCancelation.fee.fixed

string<decimal>

The amount for a fixed fee. This field is required if type is fixed.

Example:

"456.78"

lateCancelation.fee.percentage

integer<int8>

The percentage for a percentage fee. This field is required if type is percentage.

Required range: 0 <= x <= 100

noShowFee

object

required

No-show fee policy settings.

Show child attributes

noShowFee.type

enum<string>

required

The type of fee.

Available options:

none,

fixed,

percentage

noShowFee.fixed

string<decimal>

The amount for a fixed fee. This field is required if type is fixed.

Example:

"456.78"

noShowFee.percentage

integer<int8>

The percentage for a percentage fee. This field is required if type is percentage.

Required range: 0 <= x <= 100

Public APIs

API Concepts

Authentication

Appointments

Barbers

Businesses

Clients

Customers

Fees

Integrations

Invitations

Payouts

Photos

Refunds

Services

Update smart group rules

Path Parameters

Body

Response