API Reference

Update a location

patch
https://api.join.com/v3/locations/

Partially updates a location. Send only the fields you want to change. A provided address replaces the stored address in full, so always include countryCode and city when you send it. Setting isDefault: true moves the company default to this location. You cannot set isDefault: false on the current default — make another location the default instead (location_default_required).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Id of the location

Body Params

Partial update. name, address, and isDefault are all optional. A provided address replaces the stored address in full.

string
length ≤ 255

Location name

address
object

Location address

string | null

Official establishment registration number (e.g. SIRET in France); only for countries that use one. Sending null clears it

boolean

Whether this is the default location preselected for job ads

Headers
string

Selects the dated API version the request runs against, named after its release day as YYYY-MM-DD, e.g. 2026-11-01. Omit to use the current default version (2026-11-01). A value that is not a supported version is rejected with 400 unsupported_api_version.

Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?