Panic API ReferenceFixed Locations

Create fixed location

Creates a Fixed Location that can later be used to create Fixed Location callouts. Payload fields retain the API's predefined-location naming. Send `installerIdentifier` to create the site against one of your installers; omit it to create it against your own customer source. Ownership is fixed at creation and cannot be changed afterwards, so a site is moved between installers by deleting it and creating it under the new owner. Callout-scoped tokens cannot use this endpoint. Use a server token.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
locationIdentifierstringRequired
latitudestringRequired
longitudestringRequired
calloutLocationTypeIdintegerOptional
customerIdintegerOptional
externalReferenceIdstring or nullOptional<=255 characters

Optional stable fixed-location reference maintained by your integration. Supply it if you intend to reconcile or raise callouts by your own reference; omit it to identify the location by its AURA id alone.

installerIdentifierstring or nullOptional

The installer that should own the new site. Must be an installerIdentifier returned by GET /panic-api/v2/installers. Omit it, or send null, to create the site against your own customer source. Ownership is fixed at creation: it cannot be changed later, so a site is moved between installers by deleting it and creating it under the new owner. An installer with no installerIdentifier of its own cannot be named here.

locationDescriptionstringOptional
locationAdditionalInformationstringOptional
formattedAddressstringOptional
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.
requiresInternalCheckbooleanOptionalDefaults to false

Whether a responder must enter the premises to complete the site check. Defaults to false when omitted.

w3wstringOptional
duressCodestringOptional
Legacy field. New integrations should omit it.
pointOfContactlist of objectsOptional
Optional initial points of contact for the fixed location.

Response

Successful.
idintegerOptional
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.
latitudestringOptional
longitudestringOptional
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.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error