ZRM Docs
API ReferenceSite

site.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
customerIdstringYesID of the associated customer
siteNamestringYesSite name
addressobjectYesAddress
siteTypeenum(commercial, residential, industrial, government, education, healthcare, retail, mixed_use)YesSite type
occupancyProfileenum(24_7, business_hours, extended_hours, seasonal, variable)NoOccupancy profile
serviceInstructionsstringNoService instructions
accessInstructionsstringNoAccess instructions
hazardsNotesstringNoHazards notes
customerSiteManagerContactIdstringNoID of the associated customer site manager contact
activeContractIdsstring[]Yes[]Active contract ids
siteHealthScorenumberNoSite health score
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "customerId": "550e8400-e29b-41d4-a716-446655440000",
  "siteName": "example",
  "address": null,
  "siteType": "commercial",
  "occupancyProfile": "24_7",
  "serviceInstructions": "example",
  "activeContractIds": [],
  "visibilityMode": "global"
}

On this page