location.create

post

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

Creates a location or location hierarchy.

Requires the organizationWrite permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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 | null

The address of the location.

parentLocationId

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the location's parent.

isRemote

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

workplaceType

enum

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

externalName

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

extraData

object | null

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

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Responses from the location.create endpoint