Archive a household
POST/v1/households/:id/archive-date
Archives the household with the given ID and each of its active accounts, and returns the household as Get a household returns it without accounts or crm. archiveDate is the time of the request, and isActive is false. A household that is already archived keeps its archiveDate. If your firm has no household with that ID, the response is 404.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 429
The household you archived.
id is not a whole number.
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 has a membership of a household group with no end date, so it is not archived. message names the household group, and details.householdGroups lists it. Remove the household from the household group, or archive the household group, before you archive the 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.