# Patch Location

`PATCH /api/v1/locations/{id}`

Partially updates a Location object (send only the fields to change). Requires the `update` ability. Send `is_active` to activate or deactivate the location. Deactivating (`is_active: false`) is how a store closes: it leaves leaderboards, but its history keeps counting toward network totals and year-over-year benchmarks, so it does not by itself make the location deletable — see Delete Location and `deletable_on`.

## Path parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `id` | string | yes | Resource UUID. |

## Request body

```json
{
    "name": "Downtown Austin",
    "address": "401 Congress Ave",
    "city": "Austin",
    "region": "TX",
    "postal_code": "78701",
    "country": "US",
    "timezone": "America/Chicago",
    "district_id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
    "district_id_2": "c7e9a2d4-1b3f-4e8a-9c6d-5f2e8b1a7d30",
    "location_category_id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
    "is_active": true,
    "external_id": "STR-1042",
    "datasource_settings": {
        "qu": {
            "location_id": 12345
        },
        "brink": {
            "brink_api_key": "brk_live_8f2c4a1e9d7b"
        }
    }
}
```

## Example request

```bash
curl -X PATCH "https://app.franchisesee.com/api/v1/locations/9d3f6b2e-5a41-4c7e-9a0b-2f1c8e7d4a63" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Downtown Austin",
    "address": "401 Congress Ave",
    "city": "Austin",
    "region": "TX",
    "postal_code": "78701",
    "country": "US",
    "timezone": "America/Chicago",
    "district_id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
    "district_id_2": "c7e9a2d4-1b3f-4e8a-9c6d-5f2e8b1a7d30",
    "location_category_id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
    "is_active": true,
    "external_id": "STR-1042",
    "datasource_settings": {
        "qu": {
            "location_id": 12345
        },
        "brink": {
            "brink_api_key": "brk_live_8f2c4a1e9d7b"
        }
    }
}'
```

## Responses

### 200 A single Location.

```json
{
    "data": {
        "id": "9b1c8f3e-7a2d-4c5b-8e1a-2f3d4c5b6a7e",
        "external_id": "STR-1042",
        "name": "Downtown Austin",
        "address": "401 Congress Ave",
        "city": "Austin",
        "region": "TX",
        "postal_code": "78701",
        "country": "US",
        "timezone": "America/Chicago",
        "timezone_source": "pos",
        "is_private": false,
        "is_corporate": false,
        "is_active": true,
        "activation_status": "active",
        "deactivated_at": null,
        "is_deletable": false,
        "deletable_on": null,
        "district_id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
        "district_id_2": "c7e9a2d4-1b3f-4e8a-9c6d-5f2e8b1a7d30",
        "location_category_id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
        "created_at": "2025-03-14T15:22:08.000000Z",
        "updated_at": "2026-10-02T09:41:55.000000Z",
        "datasource_settings": {
            "qu": {
                "location_id": 12345
            },
            "brink": {
                "api_key_set": true
            }
        },
        "district": {
            "id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
            "name": "Central Texas",
            "external_id": "CTX",
            "district_group_id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
            "created_at": "2025-03-14T15:22:08.000000Z",
            "updated_at": "2026-10-02T09:41:55.000000Z",
            "districtGroup": {
                "id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                "name": "Region",
                "index": 1,
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z"
            }
        },
        "district2": {
            "id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
            "name": "Central Texas",
            "external_id": "CTX",
            "district_group_id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
            "created_at": "2025-03-14T15:22:08.000000Z",
            "updated_at": "2026-10-02T09:41:55.000000Z",
            "districtGroup": {
                "id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                "name": "Region",
                "index": 1,
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z"
            }
        },
        "locationCategory": {
            "id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
            "name": "Inline",
            "external_id": "INLINE",
            "location_category_group_id": "f2b6d8a1-4c3e-4e7b-a5d9-1c8e3f6b2a40",
            "sort_order": 1,
            "created_at": "2025-03-14T15:22:08.000000Z",
            "updated_at": "2026-10-02T09:41:55.000000Z",
            "locationCategoryGroup": {
                "id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
                "name": "Region",
                "index": 1,
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z"
            }
        },
        "locationGroups": [
            {
                "id": "a3c5e7f9-2b4d-4f6a-8c1e-3d5f7a9b1c20",
                "name": "Austin Metro",
                "external_id": "AUS-METRO",
                "created_at": "2025-03-14T15:22:08.000000Z",
                "updated_at": "2026-10-02T09:41:55.000000Z",
                "locations": [
                    {
                        "id": "9b1c8f3e-7a2d-4c5b-8e1a-2f3d4c5b6a7e",
                        "external_id": "STR-1042",
                        "name": "Downtown Austin",
                        "address": "401 Congress Ave",
                        "city": "Austin",
                        "region": "TX",
                        "postal_code": "78701",
                        "country": "US",
                        "timezone": "America/Chicago",
                        "timezone_source": "pos",
                        "is_private": false,
                        "is_corporate": false,
                        "is_active": true,
                        "activation_status": "active",
                        "deactivated_at": null,
                        "is_deletable": false,
                        "deletable_on": null,
                        "district_id": "3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9",
                        "district_id_2": "c7e9a2d4-1b3f-4e8a-9c6d-5f2e8b1a7d30",
                        "location_category_id": "5d8e2f1a-6c4b-4a9e-8f3d-2b7c1e9a4d60",
                        "created_at": "2025-03-14T15:22:08.000000Z",
                        "updated_at": "2026-10-02T09:41:55.000000Z",
                        "datasource_settings": {
                            "qu": {
                                "location_id": 12345
                            },
                            "brink": {
                                "api_key_set": true
                            }
                        },
                        "district": {},
                        "district2": {},
                        "locationCategory": {},
                        "locationGroups": []
                    }
                ]
            }
        ]
    }
}
```

### 401 Authentication failed or missing.

```json
{
    "message": "Unauthenticated."
}
```

### 403 The token lacks the required ability or the caller is not permitted.

```json
{
    "message": "This API token does not have the 'create' ability."
}
```

### 404 Resource not found.

```json
{
    "message": "Record not found."
}
```

### 422 Validation failed.

```json
{
    "message": "The name field is required.",
    "errors": {
        "name": [
            "The name field is required."
        ]
    }
}
```
