Skip to content
Bottle

Switch Assets or Equipment servicing on or off

PATCH
/business-settings
curl --request PATCH \
  --url https://example.com/business-settings \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "assetsEnabled": true, "servicingEnabled": true }'

Send only what changes. Refused with 403 plan_locked on a plan without the feature. Assets cannot be switched off while any product is set to track individual cylinders: 409 assets_in_use names them. Switching off hides the screens and keeps every record.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
assetsEnabled
boolean
servicingEnabled
boolean

Example generated

{
  "assetsEnabled": true,
  "servicingEnabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Saved

Media typeapplication/json
object
settings
required
object
assetsEnabled
required

Whether products can be tracked one cylinder at a time. On unless the business switches it off. Nothing changes on screen until a product is tracked.

boolean
assetScanningEnabled
required

Whether drivers and yard staff can record cylinders with the phone’s camera. Set by Bottle once the business’s cylinders have been tested.

boolean
servicingEnabled
required

Whether the business keeps service dates for the equipment its customers have. Off unless switched on.

boolean
assets
required

Hidden: not available to this business. locked: needs a bigger plan. off: available, and switched off. on: in use.

string
Allowed values: hidden locked off on
servicing
required

Hidden: not available to this business. locked: needs a bigger plan. off: available, and switched off. on: in use.

string
Allowed values: hidden locked off on
trackedProducts
required
Array<object>
object
id
required
string
name
required
string

Example 

{
  "assets": "hidden",
  "servicing": "hidden"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

Not an owner or admin, or the plan does not open this

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

404

Section titled “404”

Not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

Assets cannot be switched off while products are tracked

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

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