Update booth

PUT /api/booths/{id}

Allows you to update an existing booth under your account, given its ID, and the fields to edit.

Path parameters

id string Required

the ID of the booth to update

Body

The parameters to update a booth

account_id string

Id of the account to associate the booth to
bay_count string

Number of bays on the booth
brand_name string

Name of the booth's manufacturer
burner_size string

Burner size of the booth (MBTU)
facility_id string

Id of the facility to associate the booth to
height string

Height of the booth in ft
length string

Length of the booth in ft
model_number string

Model number of the booth
motor_size string

Motor size of the booth (HP)
name string

Human readable name to give the Booth
status string

Status to set the booth to
width string

Width of the booth in ft

Responses

200

OK
Hide response attributes Show response attributes object
- account_name string
  
  Name of the facility that the booth belongs to
- bay_count string
  
  Number of bays on the booth
- brand_name string
  
  Name of the booth's manufacturer
- burner_size string
  
  Burner size of the booth (MBTU)
- created_at string
  
  ISO8601 encoded timestamp when the booth was created
- external_id string
  
  Client identifier of the booth
- facility_id string
  
  ID of the facility that the booth belongs to
- facility_name string
  
  Name of the facility that the booth belongs to
- height string
  
  Height of the booth in ft
- id string
  
  ID of the booth within the application
- last_updated_at string
  
  ISO8601 encoded timestamp when last update was received
- length string
  
  Length of the booth in ft
- model_number string
  
  Model number of the booth
- motor_size string
  
  Motor size of the booth (HP)
- name string
  
  String name of the booth
- serial_number string
  
  Serial number of the booth
- status string
  
  Whether the booth is active or has been decommissioned
- total_runtime string
  
  Total runtime hours last reported by the PLC. Null if missing
- width string
  
  Width of the booth in ft
400

Bad Request
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
401

Unauthorized
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code
404

Not Found
Hide response attribute Show response attribute object
- error string
  
  Human readable version of the error status code

PUT /api/booths/{id}

curl \
 -X PUT http://localhost:4000/api/booths/{id} \
 -d '{"name":"Custom booth name","width":"13.5","height":"10.83","length":"20","status":"decommissioned","bay_count":"two","account_id":"f260f115-f2e6-4dde-bcab-98b10fdb8cf5","brand_name":"chinook","motor_size":"7.5","burner_size":".997","facility_id":"f260f115-f2e6-4dde-bcab-98b10fdb8cf6","model_number":"10580"}'

Request examples

{
  "name": "Custom booth name",
  "width": "13.5",
  "height": "10.83",
  "length": "20",
  "status": "decommissioned",
  "bay_count": "two",
  "account_id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf5",
  "brand_name": "chinook",
  "motor_size": "7.5",
  "burner_size": ".997",
  "facility_id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
  "model_number": "10580"
}

Response examples (200)

{
  "id": "3317efbd-0049-48d4-bb7f-4fd45315323b",
  "name": "Test Booth",
  "width": "13.5",
  "height": "10.83",
  "length": "20",
  "status": "active",
  "bay_count": "two",
  "brand_name": "chinook",
  "created_at": "2023-08-06T00:00:00Z",
  "motor_size": "7.5",
  "burner_size": ".997",
  "external_id": "ABCDEFGH",
  "facility_id": "eea97bc4-9f09-4f56-b9f6-18563055d195",
  "model_number": "10580",
  "facility_name": "Warehouse",
  "serial_number": "ABCD-123-123",
  "last_updated_at": "2023-09-06T08:00:00Z"
}

Response examples (200)

{
  "id": "3317efbd-0049-48d4-bb7f-4fd45315323b",
  "name": "Test Booth",
  "width": "13.5",
  "height": "10.83",
  "length": "20",
  "status": "active",
  "bay_count": "two",
  "brand_name": "chinook",
  "created_at": "2023-08-06T00:00:00Z",
  "motor_size": "7.5",
  "burner_size": ".997",
  "external_id": "ABCDEFGH",
  "facility_id": "eea97bc4-9f09-4f56-b9f6-18563055d195",
  "model_number": "10580",
  "facility_name": "Warehouse",
  "serial_number": "ABCD-123-123",
  "last_updated_at": "2023-09-06T08:00:00Z"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (400)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (401)

{
  "error": "Error Reason"
}

Response examples (404)

{
  "error": "Error Reason"
}

Response examples (404)

{
  "error": "Error Reason"
}