Updates an existing fixed location. Omitting `pointOfContact` leaves the existing collection unchanged, an empty array removes every contact, and a non-empty array is the complete desired collection. Existing contacts can retain their `id`; new contacts omit it. New integrations should avoid legacy `duressCode` fields even if older payloads still accepted them. Reaches your own sites and the sites owned by any of your installers.
This endpoint cannot change which installer owns a site. `installerIdentifier` may be sent only when it restates the current owner, so a location read from this API can be sent straight back unchanged. To move a site, delete it and create it under the new owner.
Callout-scoped tokens cannot use this endpoint. Use a server token.
Request
This endpoint expects an object.
calloutLocationTypeIdinteger or nullOptional
customerIdinteger or nullOptional
externalReferenceIdstring or nullOptional<=255 characters
Optional stable reference maintained by your integration. Omitting it leaves the stored value unchanged. A non-null value must not already be used by another live fixed location belonging to you or one of your installers.
installerIdentifierstring or nullOptional
Accepted only when it restates the site’s current owner, which lets a location read from this API be sent back unchanged. Ownership is fixed at creation: naming a different installer, or sending null for a site one of your installers owns, is rejected with 400. Omit the field to leave ownership untouched. Sites owned by an installer that has no installerIdentifier of its own read back as null, and that null may be sent back.
locationIdentifierstringOptional
locationDescriptionstring or nullOptional
locationAdditionalInformationstring or nullOptional
formattedAddressstring or nullOptional
buildingNamestring or nullOptional<=255 characters
Optional name of the building at this fixed location.
entranceNotestring or nullOptional<=255 characters
Instructions that help a responder find or use the correct entrance.
requiresInternalCheckbooleanOptional
Whether a responder must enter the premises to complete the site check. Omit this field to leave the existing value unchanged.
latitudestringOptional
Supply together with longitude; omit both to preserve the stored coordinates.
longitudestringOptional
Supply together with latitude; omit both to preserve the stored coordinates.
w3wstring or nullOptional
duressCodestring or nullOptional
Legacy field. New integrations should omit it.
pointOfContactlist of objectsOptional
The complete desired contact collection. An empty array removes all contacts.
Response
Successful.
customerIdinteger or nullOptional
customerSourceIdintegerOptional
installerIdentifierstring or nullOptional
The named installer that owns this site. null means either that the site belongs to your own customer source or that it belongs to an installer whose identifier has been cleared. Use customerSourceId when you need to distinguish those cases. Always null if you have no installers.
externalReferenceIdstring or nullOptional<=255 characters
Identifier maintained by the integration. It is returned and can be used for exact list filtering. New REST creates and updates reject a value already used by another live fixed location in your tree, but historical data and writes through other ingestion paths may still contain duplicates.
locationIdentifierstringOptional
A unique string you assign to identify the site.
locationDescriptionstring or nullOptional
locationAdditionalInformationstring or nullOptional
formattedAddressstring or nullOptional
buildingNamestring or nullOptional<=255 characters
Optional name of the building at this fixed location.
entranceNotestring or nullOptional<=255 characters
Instructions that help a responder find or use the correct entrance.
requiresInternalCheckbooleanOptional
Whether a responder must enter the premises to complete the site check.
w3wstring or nullOptional
what3words address for the site.
calloutLocationTypeIdinteger or nullOptional
calloutLocationTypeValuestring or nullOptional
calloutLocationTypeDescriptionstring or nullOptional
duressCodestring or nullOptional
Legacy field. New integrations should not rely on it.
medicalCoverageboolean or nullOptional
securityCoverageboolean or nullOptional
inCoverageLastCheckedAtdatetime or nullOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional
calloutLocationType.idinteger or nullOptional
Literal top-level key whose name contains a dot (a serialization artifact), not a nested calloutLocationType object. Treat these calloutLocationType.* keys as opaque; they are null unless a callout location type is assigned.
calloutLocationType.valuestring or nullOptional
calloutLocationType.descriptionstring or nullOptional
calloutLocationType.addressTypestring or nullOptional
calloutLocationType.createdAtdatetime or nullOptional
calloutLocationType.updatedAtdatetime or nullOptional
calloutLocationType.locationCategorystring or nullOptional
calloutLocationType.deprecatedAtdatetime or nullOptional
pointOfContactlist of objectsOptional
Fixed-location contacts. Returned by singular reads and by create and update operations. Deliberately omitted from the broad list response, because contact email addresses and mobile numbers are personal data; resolve an id from the list and read that fixed location singly when you need them.
