---
title: "location.create"
method: POST
path: "/location.create"
tags: ["Location"]
---

# location.create

`POST /location.create`

Creates a location or location hierarchy.

**Requires the [`organizationWrite`](authentication#permissions-locationcreate) permission.**

## Request body

- LocationCreateRequest
  - `name` string, 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.
  - `address` object, nullable — The address for the location
    - `postalAddress` object, required — The postal address for the location
      - `addressCountry` string — The country for the location address
      - `addressRegion` string — The region for the location address
      - `addressLocality` string — The locality for the location address
      - `postalCode` string — The postal code for the location address
      - `streetAddress` string — The street address for the location
  - `parentLocationId` string, uuid, nullable — The id of the location's parent.
  - `isRemote` boolean, 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.
  - `externalName` string, nullable — An alternate candidate-facing name for this location used on job boards and in the API.
  - `extraData` object, nullable — Structured key-value information for your own use and reference. Do not store personally identifiable information in this field.

## Response `200`

Responses from the location.create endpoint

- union
  - LocationCreateSuccessResponse
    - `success` true, required
    - `results` Location, required
      - `id` string, uuid, required — The unique identifier for the location
      - `name` string, required — The name of the location
      - `externalName` string, nullable, required — An alternate candidate-facing name for this location used on job boards and in the API
      - `isArchived` boolean, required — Whether the location is archived
      - `isRemote` boolean, nullable, required — Deprecated. Use workplaceType instead.
      - `address` object, nullable, required — The address for the location
        - `postalAddress` object, required — The postal address for the location
          - `addressCountry` string — The country for the location address
          - `addressRegion` string — The region for the location address
          - `addressLocality` string — The locality for the location address
          - `postalCode` string — The postal code for the location address
          - `streetAddress` string — The street address for the location
      - `parentLocationId` string, uuid, nullable, required — The unique identifier for the parent location hierarchy, if any
      - `type` 'Location' | 'LocationHierarchy', required — The type of the location component
      - `workplaceType` 'OnSite' | 'Hybrid' | 'Remote', nullable, required — The type of workplace
      - `extraData` object, nullable, required — Structured key-value information for your own use and reference. Do not store personally identifiable information in this field.
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)