Skip to content

Change the bank holiday settings

PATCH
/closure-settings
curl --request PATCH \
--url https://example.com/closure-settings \
--header 'Content-Type: application/json' \
--cookie bottle.session_token=<bottle.session_token> \
--data '{ "bankHolidayRegion": "england-and-wales", "deliverOnBankHolidays": true }'
Media typeapplication/json
object
bankHolidayRegion
string
Allowed values: england-and-wales scotland northern-ireland
deliverOnBankHolidays
boolean

Saved

Media typeapplication/json
object
bankHolidayRegion
required
string
Allowed values: england-and-wales scotland northern-ireland
deliverOnBankHolidays
required
boolean
updatedAt
required
string format: date-time
Example
{
"bankHolidayRegion": "england-and-wales"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}