Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Location

location.create

Creates a location or location hierarchy.

Requires the organizationWrite permission.

post/location.create

Request body

namestring required

The name of the location.

type'Location' | 'LocationHierarchy' required

A Location represents an actual location that jobs and employees can be associated with. A Location Hierarchy is a grouping of locations or other location hierarchies.

parentLocationIdstring uuid nullable

The id of the location's parent.

isRemoteboolean nullable

Whether the location should be labeled as remote. LocationHierarchies cannot be labeled as remote.

workplaceType'OnSite' | 'Hybrid' | 'Remote' nullable

The type of workplace. LocationHierarchies cannot be labeled with a workplaceType.

externalNamestring nullable

An alternate candidate-facing name for this location used on job boards and in the API.

extraDataobject nullable

Structured key-value information for your own use and reference. Do not store personally identifiable information in this field.

Example request

{
  "parentLocationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "extraData": {
    "partner_external_object_id": "12345",
    "partner_additional_data": "f763ba0e4"
  }
}

Response

Responses from the location.create 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"
    }
  }
}