Skip to content
Docs
API reference / Districts

Patch District

MD View as MarkdownPlain text version of this page
Open in ClaudeAsk questions about this page Open in ChatGPTAsk questions about this page
PATCH /api/v1/districts/{id}

Token needs the update ability. About tokens

Partially updates a District object. Requires the update ability.

Path parameters

  • id string (uuid) required
    Resource UUID.

Request body application/json

  • name string
  • district_group_id string (uuid)
  • external_id string nullable
    Unique per tenant.

Responses

    • data District
      • id string (uuid)
      • name string
      • external_id string nullable
      • district_group_id string (uuid) nullable
      • created_at string (date-time) nullable
      • updated_at string (date-time) nullable
      • districtGroup object nullable
        Present only when included.
        • id string (uuid)
        • name string
        • index integer
        • created_at string (date-time) nullable
        • updated_at string (date-time) nullable
    • message string
    • message string
    • message string
    • message string
    • errors object 
curl -X PATCH "https://app.franchisesee.com/api/v1/districts/9d3f6b2e-5a41-4c7e-9a0b-2f1c8e7d4a63" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Central Texas",
    "district_group_id": "e1a4c8b2-7d3f-4b6e-9a2c-8f5d1e3b7a90",
    "external_id": "CTX"
}'
Response 
{
    "data": {
        "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"
        }
    }
}