Update a household
PUT/v1/households/:id
Replaces the model, billing, trade proposal and tolerance settings and the security restrictions of the household with the given ID with the ones in the request body, and returns the household as Get a household returns it without accounts or crm. Send every required field. A field you leave out or send as null is cleared, except feeChargeLocation, which is set to Custodian Billed. The security restrictions you send replace all of the household's security restrictions. Other fields, such as name, are not read. If your firm has no household with that ID, the response is 404.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 429
The household you updated.
id is not a whole number, or the request body is invalid, for example rebalancePeriod is not d, w, m, q or y, rebalancePeriodStartDate is not a date, or securityRestrictions is missing.
The access token is missing, invalid, or expired.
The access token does not have the write:household scope or the write:crm scope.
Your firm has no household with that ID.
The household is a member of a household group today, and the request would change its fee structure or its billing minimum. Nothing changes. A feeStructureId or billingMinimumId that you leave out is also a change when the household has one. message names the household group, and details.householdGroups lists it. Send the feeStructureId and billingMinimumId that the household has, or change the fee structure and the billing minimum on the household group.
Too many requests. Wait the number of seconds in the Retry-After-per-person header (script-audience tokens) or the Retry-After header (other requests) before you retry. See Rate limit.