Update a location

patch/locations/v1/locations/{id}

Update a location's information by specifying its location ID.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

The unique identifier for the location.

Request Body schema: application/merge-patch+json
required

Updated Location Information

Array of objects (server.UpdateAddressNBRequest)
Array of objects (server.UpdateContactsNBRequest)
description
string

A long description of the location.

expiredAt
string

The date the location expired.

name
string <= 100 characters

The name of location.

locationType
string (db.LocationType)

Type of location.

Value: "building"
validated
boolean
Default: true

Boolean confirming whether the location has been validated or not.

validatedAt
string

The date the location was validated in the format mm-dd-yyyy.

validatedByEmail
string

Email address of the workspace user that validated the location.

validatedByName
string

The name of the workspace user that validated the location.

validationCycle
string (db.ValidationCycle)

An integer that defines, in months, how long the location remains validated.

Enum: "" "6" "12" "18"
validationExpired
boolean
Default: false

A boolean confirming whether the location validation has expired or not.

Responses
200

OK

400

Bad request

404

Not found

500

Internal server error

Request samples
application/merge-patch+json
{
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "description": "string",
  • "expiredAt": "string",
  • "name": "string",
  • "locationType": "building",
  • "validated": true,
  • "validatedAt": "string",
  • "validatedByEmail": "string",
  • "validatedByName": "string",
  • "validationCycle": "",
  • "validationExpired": false
}
Response samples
application/json
{
  • "addresses": [
    ],
  • "contacts": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "locationType": "building",
  • "createdAt": "string",
  • "description": "string",
  • "expiredAt": "string",
  • "generation": 0,
  • "type": "locations/external-service",
  • "updatedAt": "string",
  • "validated": true,
  • "validatedAt": "string",
  • "validatedByEmail": "string",
  • "validatedByName": "string",
  • "validationCycle": "",
  • "validationExpired": false
}