User Data Capture

Delete a data capture form

DELETE/data-capture-forms/{id}
user-data-capture:writedelete_data_capture_formDestructiveIdempotent

Deletes the data capture form and returns 204. Only the form itself goes: the hidden form underneath and every answer users gave stay, but its fields stop appearing under data_capture on investors and in GET /data-capture-fields. It has no dry run and can't be undone through the API. A repeat call returns 404. Emits data_capture_form.deleted and sends no email.

Path parameters

  • idstring (uuid)Required#

    The data capture form's id, a uuid. An unknown or deleted id returns 404.

Responses

204

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