Update the trading settings of a household
PUT/v1/households/:id/trading
Replaces the model, trade proposal, tolerance, lot selection and model assignment settings of the household with the given ID with the ones in the request body, and, for each account in accounts, its model and its security restrictions. An account's security restrictions become the entries of holdings with its accountId and restrictSecurity true. Accounts you leave out of accounts do not change. A field you leave out or send as null is cleared. securityRestrictions is not read. Returns the household as Get a household returns it without accounts or crm. If your firm has no household with that ID, or an account in accounts is not an account of that household, the response is 404 and nothing changes.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 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, holdings is not an array, a treatment is not hold_only, sell_no_tax or exclude, or a value of accounts has no whole number accountId.
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, or an account in accounts is not an account of that household.
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.