Customer Families API
Group a parent customer with the customers beneath it, and read or reshape that hierarchy:
GET /customer-families- List all customer familiesGET /customer-families/{customer_family_id}- Retrieve a customer familyGET /customer-families/{customer_family_id}/members- List the members of a familyPOST /customer-families- Create a family, with its whole hierarchy, in one callPATCH /customer-families/{customer_family_id}- Rename a familyDELETE /customer-families/{customer_family_id}- Dissolve a familyPOST /customer-families/{customer_family_id}/members- Add members and reparent existing onesDELETE /customer-families/{customer_family_id}/members/{customer_id}- Remove one member
A family is a named grouping of at least two customers. The root parent is the member with no
parent_customer_id; every other member reports to exactly one member above it, and those members
can themselves have children. A customer can belong to only one family at a time.
Family responses do not include members. GET /customer-families/{customer_family_id}/members pages
the whole family, each member carrying its own parent_customer_id. A parent_customer_id query
parameter narrows the page to that member's direct children.
is_root_parent marks the customer at the top of the tree, not any customer that has children.
Removing a member promotes its children to its former parent. If the removal would leave a single
member, the family is dissolved instead; the response is 204 either way. The root parent cannot be
removed this way. Dissolving deletes no customer.
Customers gain family_id and parent_customer_id, both read-only and both absent when the
customer belongs to no family. They are ignored if sent to POST or PUT /customers.
Applies to V4 only.
