Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Location

location.restore

Restores an archived location or location hierarchy.

Requires the organizationWrite permission.

post/location.restore

Request body

locationIdstring uuid required

The id of the location to restore

Example request

{
  "locationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the location.restore endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "name": "Bay Area Office",
    "externalName": "San Francisco Office",
    "isArchived": false,
    "isRemote": false,
    "address": {
      "postalAddress": {
        "addressCountry": "United States",
        "addressRegion": "California",
        "addressLocality": "San Francisco",
        "postalCode": "94108",
        "streetAddress": "49 Geary St Suite 411"
      }
    },
    "parentLocationId": null,
    "type": "Location",
    "workplaceType": "Hybrid",
    "extraData": {
      "partner_external_object_id": "12345"
    }
  }
}