---
title: "Renames a customer family"
method: PATCH
path: "/customer-families/{customer_family_id}"
tags: ["Customer Families"]
---

# Renames a customer family

`PATCH /customer-families/{customer_family_id}`

## Request

- Base URL: `https://api.rillet.com`
- URL: `https://api.rillet.com/customer-families/{customer_family_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/rillet/apis/rillet-accounting-api/docs/customer-families/:customer_family_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Changes the family's name. Membership is untouched: anything else in the body is ignored,
so use the members endpoints to change who belongs.

## Path parameters

- `customer_family_id` string, uuid, required

## Request body

- RenameCustomerFamilyRequest: The family's new name. Membership cannot be changed here.
  - `name` string, required

## Response `200`

OK

- CustomerFamily: A customer family, without its members.
  - `id` string, uuid, required
  - `name` string, required: Defaults to the root parent customer's name when omitted on create.
  - `root_parent_customer_id` string, uuid, required: The customer at the top of the tree. Every family has exactly one. Not to be confused with a member's parent_customer_id, which points at whoever that member reports to.
  - `member_count` integer, required: How many customers are in the family, counting the one at the top. Always at least two.

## Other responses

- `default`: Error

## Changes

- **2026-11-03** `c393d0102005`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/rillet/apis/rillet-accounting-api/changes/customer-families/:customer_family_id/patch.md)

---

[API](https://skmtc.dev/rillet/apis/rillet-accounting-api.md) - [All operations](https://skmtc.dev/rillet/apis/rillet-accounting-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rillet/apis/rillet-accounting-api/revisions/c393d0102005?raw)
