location.create

post

https://api.ashbyhq.com/location.create

Creates a location or location hierarchy.

Requires the organizationWrite permission.

Body Params

name

string

required

The name of the location.

type

string

enum

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.

Allowed:

address

object

The address of the location.

parentLocationId

string

The id of the location's parent.

isRemote

boolean

Defaults to false

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

workplaceType

string

enum

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

Allowed:

externalName

string

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

extraData

object

This field stores information, structured as key-value pairs, for your own use and reference, for example a unique identifier for your own system. Do not store personally identifiable information (PII) in this field. In addition, the following constraints apply:

Keys must be strings of at most 100 characters.
Values must be strings of at most 512 characters.
The total size of the extra data must be less than 1kb.

We recommend using a prefix for your keys to avoid collisions with other systems, as data stored in this field is available to all API users with permission to access the underlying object.

Response

200Responses for the location.create endpoint