Skip to content
Docs
API reference / Location Categories

Patch Location Category

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/location-categories/{id}

Token needs the update ability. About tokens

Partially updates a LocationCategory object. Requires the update ability.

Path parameters

  • id string (uuid) required
    Resource UUID.

Request body application/json

  • name string
  • location_category_group_id string (uuid)
  • external_id string nullable
    Unique per tenant.
  • sort_order integer nullable

Responses

    • data LocationCategory
      • id string (uuid)
      • name string
      • external_id string nullable
      • location_category_group_id string (uuid) nullable
      • sort_order integer nullable
      • created_at string (date-time) nullable
      • updated_at string (date-time) nullable
      • locationCategoryGroup 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/location-categories/9d3f6b2e-5a41-4c7e-9a0b-2f1c8e7d4a63" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Inline",
    "location_category_group_id": "f2b6d8a1-4c3e-4e7b-a5d9-1c8e3f6b2a40",
    "external_id": "INLINE",
    "sort_order": 1
}'
Response 
{
    "data": {
        "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"
        }
    }
}