Change servicing reminder settings
PATCH
/service-settings
const url = 'https://example.com/service-settings';const options = { method: 'PATCH', headers: { cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>', 'Content-Type': 'application/json' }, body: '{"remindersOn":true,"reminderDays":[1],"remindCustomer":true,"remindOffice":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
remindersOn
boolean
reminderDays
Array<integer>
remindCustomer
boolean
remindOffice
boolean
Example generated
{ "remindersOn": true, "reminderDays": [ 1 ], "remindCustomer": true, "remindOffice": true}Responses
Section titled “Responses”The settings afterwards
Media typeapplication/json
object
remindersOn
required
boolean
reminderDays
required
Array<integer>
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
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}