Forms

Delete a generated document

DELETE/submissions/{submission_id}/documents/{id}
forms:writedelete_submission_documentDestructiveIdempotent

Soft-deletes the generated document and returns 204. It can't be undone through the API, but POST /submissions/{id}/actions/generate-documents renders a new one. It has no dry run, and a repeat returns 404. Sends no webhook and no email.

Path parameters

  • submission_idstring (uuid)Required#

    The submission's id, a uuid. An unknown id, or a submission you cannot see, returns 404.

  • idstring (uuid)Required#

    The generated document's id, a uuid. An unknown id, or a document of another submission, returns 404.

Responses

204

The generated document was deleted.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/submissions/{submission_id}/documents/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"