Skip to content

Change servicing reminder settings

PATCH
/service-settings
curl --request PATCH \
--url https://example.com/service-settings \
--header 'Content-Type: application/json' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
--data '{ "remindersOn": true, "reminderDays": [ 1 ], "remindCustomer": true, "remindOffice": true }'

Values left out stay as they are. reminderDays replaces the list: up to three, each once. Each reminder goes once for each due date; changing these never sends one again.

Media typeapplication/json
object
remindersOn
boolean
reminderDays
Array<integer>
<= 3 items
remindCustomer
boolean
remindOffice
boolean

Example generated

{
"remindersOn": true,
"reminderDays": [
1
],
"remindCustomer": true,
"remindOffice": true
}

The settings afterwards

Media typeapplication/json
object
remindersOn
required
boolean
reminderDays
required
Array<integer>
<= 3 items
remindCustomer
required
boolean
remindOffice
required
boolean

Example generated

{
"remindersOn": true,
"reminderDays": [
1
],
"remindCustomer": true,
"remindOffice": true
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not an owner or admin, missing scope, or the plan does not open Equipment servicing

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not found, or Equipment servicing is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up

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"
}
]
}