Document Platform

Create an own heartbeat definition for a building

Org members can create a recurring scheduled Ask turn for themselves on a building they can read. Creation is idempotent: an identical definition returns the existing row with was_existing=true.

post/customers/{customerId}/buildings/{buildingId}/heartbeats/mine

Request

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

Path parameters

customerIdstring uuid required
buildingIdstring uuid required

Request body

task_promptstring required
days_of_weekinteger[] required
hourinteger required
minuteinteger required
time_zonestring required

Response

Default Response

was_existingboolean required

Changes

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