API Reference

Update a location

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

Updates the fields you supply on a location. Omitted fields stay unchanged.

  • A supplied address replaces the entire address: include countryCode and city, plus any street details you want to retain.
  • Setting isDefault: true makes this location the company default.
  • You cannot set isDefault: false on the current default (location_default_required). Make another location the default instead.
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 a dated API revision in YYYY-MM-DD format, such as 2026-11-01. Pin this header to choose the revision explicitly; omitting it uses the server’s default. An unsupported value returns 400 unsupported_api_version. See Versions and compatibility.

Responses

Updated about 5 hours 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 about 5 hours ago

Did this page help you?