RIrillet
Customer Families

Adds members to a customer family

Changed on

Adds customers to a family and moves members already in it, in one call. Naming a member that already belongs gives it a new parent, so a branch can be restructured in a single request rather than through a sequence that would be invalid halfway through.

post/customer-families/{customer_family_id}/members

Request

  • Base URL
    https://api.rillet.com
  • Auth
    HTTP bearer

Path parameters

customer_family_idstring uuid required

UUID of the customer family to add members to.

Request body

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