Skip to navigation

Preview what a delete would destroy

For a client’s own delete confirmation screen: the rows that would go, the links that would be broken, and the sentences to show. When plan.blocked is true the delete will be refused and the sentences are the refusal — render them and disable the button rather than letting the user find out on the DELETE.

Gated on the same permission the delete itself requires, so a caller cannot use the preview to learn about rows they could not delete. A row belonging to another organisation answers 404, the same as one that does not exist. Works with an API token.

Authentication

AuthorizationBearer

JWT access token obtained from POST /api/v1/auth/login, or a finput_sk_... API token

Query parameters

targetenumRequired
What kind of row is being deleted.
Allowed values:
idintegerRequired
The row's id.

Response

The plan and its sentences.
planobjectOptional
summary_lineslist of stringsOptional

The sentences the delete modal renders — the refusal when blocked, the consequences when not.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error