Forms

Delete a form

DELETE/forms/{id}
forms:writedelete_formDestructiveIdempotent

Deletes the form and returns 204. It also removes the form's investor preference and data capture links. It can't be undone through the API and has no dry run. A repeat call returns 404. A compliance form that a published onboarding flow uses is refused with 409 conflict. Emits form.deleted and sends no email. POST /forms/{id}/copies can make a new form from one you still have.

Path parameters

  • idstring (uuid)Required#

    The form's id, a uuid. An unknown id, or a hidden form, returns 404.

Responses

204

The form 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
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

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/forms/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"