Document Platform

Start an agent on a building

Start an agent of this kind on the building, or update the brief of the one already there with this id. Another agent of the same kind on the building is a 409: the building is already watched.

put/customers/{customerId}/buildings/{buildingId}/agents/{kind}

Request

  • Base URL: http://localhost:9000
  • URL: http://localhost:9000/customers/{customerId}/buildings/{buildingId}/agents/{kind}
  • Auth: API key in header x-api-key

Path parameters

customerIdstring uuid required
buildingIdstring uuid required
kind'building-safety-case' required

Request body

idstring uuid required
briefobject

Response

Default Response

idstring uuid required
kind'building-safety-case' required
activatedBystring required
briefobject

Changes

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