Archive an account
POST/v1/accounts/:id/archive-date
Archives the account with the given ID, and returns the account as Get an account returns it without balances. archiveDate is the time of the request, and isActive is false. An account that is already archived keeps its archiveDate. If your firm has no account with that ID, the response is 404.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 429
The account 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.
Your firm has no account with that ID.
The account is the payer account of a household group, so it is not archived. message names the household group, and details.householdGroups lists it. 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.