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.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
externalReferenceIdstringRequired
locationIdentifierstringRequired
latitudestringRequired
longitudestringRequired
calloutLocationTypeIdintegerOptional
customerIdintegerOptional
locationDescriptionstringOptional
locationAdditionalInformationstringOptional
formattedAddressstringOptional
w3wstringOptional
duressCodestringOptional
Legacy field. New integrations should omit it.

Response

Successful.
idinteger
customerIdinteger or null
customerSourceIdinteger
externalReferenceIdstring
locationIdentifierstring
A unique string you assign to identify the site.
locationDescriptionstring or null
locationAdditionalInformationstring or null
formattedAddressstring or null
latitudestring
longitudestring
w3wstring or null
what3words address for the site.
calloutLocationTypeIdinteger or null
calloutLocationTypeValuestring or null
calloutLocationTypeDescriptionstring or null
duressCodestring or null
Legacy field. New integrations should not rely on it.
medicalCoverageboolean or null
securityCoverageboolean or null
inCoverageLastCheckedAtdatetime or null
createdAtdatetime
updatedAtdatetime
calloutLocationType.idinteger or null

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 null
calloutLocationType.descriptionstring or null
calloutLocationType.addressTypestring or null
calloutLocationType.createdAtdatetime or null
calloutLocationType.updatedAtdatetime or null

Errors

400
Bad Request Error
401
Unauthorized Error