> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit Place

> Update properties of an existing place.

Update one or more properties of an existing place. You can update location details, contact information, radius, team assignments, and custom data.

### REQUEST

```shell theme={null}
POST https://api.hellotracks.com/api/editplace

{
   "data": {
      "uid": "p1q2r3",
      "name": "Updated Place Name",
      "radius": 100,
      "phone": "+14155551234",
      "email": "updated@example.com",
      "address": "456 New Street",
      "city": "San Francisco",
      "postalcode": "94105",
      "state": "CA",
      "country_code": "US",
      "color": "#FF5733",
      "linkedForms": "form1,form2",
      "teams": [1, 2, 3],
      "extended_data": [
        {"key": "manager", "val": "Jane Smith"},
        {"key": "notes", "val": "Updated location"}
      ]
   }
}
```

Alternatively, you can edit multiple places at once using the `uids` array:

```shell theme={null}
POST https://api.hellotracks.com/api/editplace

{
   "data": {
      "uids": ["uid1", "uid2", "uid3"],
      "radius": 150,
      "teams": [1, 2]
   }
}
```

**uid** `string` *required*

UID of the place to edit. Required unless using `uids` for batch editing.

**uids** `array`

Array of place UIDs to edit multiple places with the same changes. Alternative to `uid` for batch operations.

**name** `string`

Update the place name

**phone** `string`

Update contact phone number

**email** `string`

Update contact email address

**address** `string`

Update street address

**city** `string`

Update city name

**postalcode** `string`

Update postal/ZIP code

**state** `string`

Update state/province/region

**country\_code** `string`

Update ISO country code (e.g., "US", "GB", "DE")

**color** `string`

Update color code in hexadecimal format (e.g., "#22c328")

**radius** `integer`

Update check-in radius in meters

**linkedForms** `string`

Update linked form IDs (comma-separated)

**teams** `array`

Update team assignments. Array of team numbers (integers). Replaces existing team assignments.

**extended\_data** `array`

Update or add custom data fields. Array of key-value pair objects.

Example: `[{"key": "manager", "val": "John Doe"}, {"key": "capacity", "val": "100"}]`

### Permissions

* You must have edit permissions for the place(s) you're modifying
* Workers may have restricted editing capabilities depending on company settings
* You can only edit places within your organization or network

### Batch Editing

When using the `uids` array, all specified places will be updated with the same values. This is useful for:

* Updating radius for multiple locations
* Reassigning places to different teams
* Bulk updates to any common property

### RESPONSE

```shell theme={null}
{
  "status": 0
}
```

**status** `integer` *required*

Status code. `0` indicates success.

### Examples

```bash Update Single Place theme={null}
curl -X POST https://api.hellotracks.com/api/editplace \
  --header 'API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  -d '{
    "data": {
      "uid": "abc123",
      "name": "Main Warehouse",
      "radius": 150,
      "extended_data": [
        {"key": "manager", "val": "John Smith"},
        {"key": "hours", "val": "8AM-6PM"}
      ]
    }
  }'
```

```bash Batch Update Multiple Places theme={null}
curl -X POST https://api.hellotracks.com/api/editplace \
  --header 'API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  -d '{
    "data": {
      "uids": ["place1", "place2", "place3"],
      "teams": [1, 2],
      "radius": 100
    }
  }'
```

> [!NOTE]
>
> **Tip:** Only include the fields you want to update. Omitted fields will remain unchanged.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.