Assign accounts to households
POST/v1/households/accounts/mappings
For each household ID in the request body, assigns the household the accounts in its array, and removes its other accounts, which are left with no household. Households you leave out do not change. Returns the accounts assigned to households as Get the accounts assigned to households returns them. If your firm has no household with an ID in the request body, or no account with an ID in it, the response is 404 and nothing changes.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 429
The accounts assigned to households after the change.
The request body is invalid, for example a key is not a whole number of at least 1, or a value is not an array of whole numbers of at least 1.
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 a key of the request body, or no account with an ID in one of its arrays.
An account that the request would move to another household or remove from its household is the payer account of a household group. Nothing changes. message names each such account and its household group, and details.payerAccounts lists them. Designate another payer account or clear the payer account of the household group first.
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.