Delete a model

DELETE 
/v1/models/models/:id

Deletes the model with the given ID. If accounts or households are assigned to the model, send newModelId to assign them another model of your firm, or 0 to leave them with no model; the change and the delete succeed or fail together. To see whether any are assigned, call Get the number of accounts and households assigned to a model. Returns deleted: true. If your firm has no model with the given ID, or no model with the ID in newModelId, the response is 404.

Request

Responses

200

Whether the model was deleted.

400

id or newModelId is not a whole number.

401

The access token is missing, invalid, or expired.

403

The access token does not have the write:model scope.

404

Your firm has no model with the ID in the path, or none with the ID in newModelId.

429

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.