Boats

Partially update a boat

Updates only the fields present in the body. To retire a boat: PATCH { isActive: false }. To unlist from the marketplace: PATCH { isListed: false }. Per spec §4.4 this endpoint is not idempotent (PATCH semantics).

patch/api/v1/boats/{id}

Request

  • Base URL: http://localhost:3002
  • URL: http://localhost:3002/api/v1/boats/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

namestring
type'SAILBOAT' | 'POWERBOAT' | 'PONTOON' | 'JETSKI' | 'KAYAK' | 'CANOE' | 'YACHT' | 'OTHER'
harborIdstring
capacityinteger
slipNumberstring nullable
gateCodestring nullable
slipInstructionsstring nullable
fuelSurchargeEnabledboolean
fuelSurchargeAmountinteger nullable
depositType'FIXED' | 'PERCENTAGE'
depositValueinteger
photosstring[]
isActiveboolean
isListedboolean

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.