RIrillet
Customer Families

Creates a customer family

Changed on

Creates a family from customers that do not already belong to one. A child may report to another child, so a multi-level hierarchy is created in one call.

post/customer-families

Request

Request body

namestring

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

root_parent_customer_idstring uuid required

The customer at the top of the tree. It must not already belong to a family.

Example request

{
  "name": "Acme Holdings"
}

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