Space Docs
API ReferenceSite

site.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
customerIdstringYes—ID of the associated customer
siteNamestringYes—Site name
addressobjectYes—Address
siteTypeenum(commercial, residential, industrial, government, education, healthcare, retail, mixed_use)Yes—Site type
occupancyProfileenum(24_7, business_hours, extended_hours, seasonal, variable)No—Occupancy profile
serviceInstructionsstring,nullNo—Service instructions
accessInstructionsstring,nullNo—Access instructions
hazardsNotesstring,nullNo—Hazards notes
customerSiteManagerContactIdunknownNo—ID of the associated customer site manager contact
activeContractIdsstring[]Yes[]Active contract ids
siteHealthScorenumberNo—Site health score
workspaceIdstringNo—ID of the associated workspace
visibilityModeunknownNo—Visibility mode

Example

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

On this page