RIrillet
Customer Families

Renames a customer family

Changed on

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

patch/customer-families/{customer_family_id}

Request

Path parameters

customer_family_idstring uuid required

UUID of the customer family to rename.

Request body

namestring required

Example request

{
  "name": "Acme Holdings (EMEA)"
}

Response

OK

idstring uuid required
namestring required

Defaults to the root parent customer's name when omitted on create.

root_parent_customer_idstring 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_countinteger required

How many customers are in the family, counting the one at the top. Always at least two.

Example response

{
  "name": "Acme Holdings",
  "member_count": 4
}

Changes