Create or replace a location

Create a missing location or replace an existing record with the supplied data.

These records describe the places where your organization hires or schedules work.

Path Params
uuid
required

location unique identifier

Body Params
string
required
string
uuid
string
string
string
string
string
string
enum

2-letter ISO country code

string
string
string
string

Stable identifier for this location in the customer's HRIS. Unique per company and immutable once set; used as a composite upsert lookup key.

externalLocation
object

Metadata storage of the location data from an external source

string

External id of the Hire location this location is linked to. Separate from externalLocation, which can hold another system's reference. WX sets it whenever it writes a Hire-sourced externalLocation.

hireSmsNumber
object | null

The Hire SMS number assigned to this location. Hire owns it; null means Hire holds none.

hireWhatsAppNumber
object | null

The Hire WhatsApp number assigned to this location. Hire owns it; null means Hire holds none.

string | null

Written by Hire's pushes, as "<sms external id or ''>|<whatsapp external id or ''>". Hire treats any other writer's value as a request and corrects it.

geolocation
object
uuid | null
boolean
uuid | null
uuid | null
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json