Delete a recipe
Deletes a recipe. This is a hard delete and it cannot be undone: the output tables the recipe produced are dropped, its configuration is removed, and the intermediate recipes it was built on go with it. The cascade follows the recipes this one reads from, not the ones that read it: a recipe built on top of this one stays in place and breaks.
The extractions created for the recipe are not deleted. They keep running on their schedule and the data they have already collected stays where it is, so a recipe deployed from the same template in the same workspace later sees the data of all those accounts, whatever set of accounts its own configuration names. Deleting a recipe is therefore not a way to narrow what a result contains; if the data of an account has to be taken out, contact support.
The template slot and the output table name are free again as soon as the 204 arrives, but the registration of the table on the platform side is removed asynchronously. Before deploying the same template here again, wait until the recipe is gone from GET /api/v3.1/automated-recipes/; a create sent straight after the 204 can be given the datatable_id of the old table, which is then dropped.
Answers 204 with an empty body. If the recipe itself could not be deleted, the answer is 500 delete_incomplete; an intermediate recipe that could not be deleted is logged on our side and does not change the answer.
Request
- Base URLhttps://embedded.improvado.io
- Auth
- HTTP bearer
- or API key in cookie dts_session_id
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Recipe identifier, as returned when the recipe was created. A string of digits.
Response
The recipe was deleted. The response has no body.
Changes
No recorded changes to this operation across all 1 revision of this API.