Forms

Delete a field of a form

DELETE/forms/{form_id}/fields/{id}
forms:writedelete_form_fieldDestructiveIdempotent

Deletes the field and returns 204. It can't be undone and has no dry run; add the field again with POST /forms/{form_id}/fields. A repeat call returns 404. While another field's condition targets it the delete is refused with 409 conflict; clear those conditions first. A field used by a compliance classification or flow, or assigned to a DocuSign element, is refused with 409 conflict too. Published forms can be changed too. Emits form_field.deleted and sends no email.

Path parameters

  • form_idstring (uuid)Required#

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

  • idstring (uuid)Required#

    The field's id, a uuid. A field of another form returns 404.

Responses

204

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