Skip to main content
PATCH
/
v1
/
locations
/
{id}
Update a location
curl --request PATCH \
  --url https://api.plane.com/v1/locations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "address": {
    "address.line1": "<string>",
    "address.line2": "<string>",
    "address.city": "<string>",
    "address.state": "<string>",
    "address.postal_code": "<string>",
    "address.country": "<string>"
  }
}
'
{
  "id": "loc_cNqYX2J3s9bI2Aa",
  "name": "SF Headquarters",
  "address": {
    "line1": "123 Main Street",
    "line2": null,
    "city": "Oakland",
    "state": "CA",
    "postal_code": "94612",
    "country": "US"
  },
  "created": "2024-01-15T00:00:00Z",
  "updated": "2024-02-10T00:00:00Z"
}
Use this endpoint when a work location has been renamed or its address details have changed.

​
Parameters

​
id
string
required
The ID of the location to update.
​
name
string
New display name for the location.
​
address
object
Address fields to update. Plane merges the provided fields onto the existing address.

​
Returns

Returns the updated Location object. 
{
  "id": "loc_cNqYX2J3s9bI2Aa",
  "name": "SF Headquarters",
  "address": {
    "line1": "123 Main Street",
    "line2": null,
    "city": "Oakland",
    "state": "CA",
    "postal_code": "94612",
    "country": "US"
  },
  "created": "2024-01-15T00:00:00Z",
  "updated": "2024-02-10T00:00:00Z"
}