For AI agents: markdown of this page — /docs-content-en/entities/crm-forms/delete.md documentation index — /llms.txt

Delete a form

DELETE /v1/crm-forms/:id

Bitrix24 method: crm.form.delete (REST v3).

Scope: crm. Requires a READWRITE key.

Behavior and parameters

Permanently deletes a form. Removal is irreversible. An active form requires an explicit confirm=true query parameter; the wrapper never confirms on your behalf. An optional updatedTime query parameter enables optimistic locking. System forms cannot be deleted. HTTP 200 returns {deleted:true}. Do not blindly retry an ambiguous write; read the form first.

Bitrix24 does not perform writes on free or demo plans. Permissions, quota and business rules are checked by Bitrix24.

Example

Terminal
curl -X DELETE 'https://vibecode.bitrix24.com/v1/crm-forms/8?confirm=true' \
  -H 'X-Api-Key: YOUR_API_KEY'

For an OAuth application, use its key and the Authorization: Bearer USER_SESSION_TOKEN header.

JSON
{"success":true,"data":{"deleted":true}}

Errors

HTTP Code Reason
HTTP400 CodeINVALID_PARAMS ReasonInvalid id, body or query shape
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY ReasonREADONLY key
HTTP402 CodeCRM_FORM_WRITE_RESTRICTED ReasonBitrix24 plan does not allow writing CRM forms
HTTP403 CodeSCOPE_DENIED ReasonMissing crm scope
HTTP403 CodeBITRIX_ACCESS_DENIED ReasonBitrix24 permission refusal
HTTP403 CodeCRM_FORM_SYSTEM_IMMUTABLE ReasonSystem form cannot be changed
HTTP404 CodeENTITY_NOT_FOUND ReasonForm does not exist
HTTP409 CodeCRM_FORM_VERSION_MISMATCH ReasonVersion is stale; error.currentUpdatedTime contains the current version
HTTP409 CodeCRM_FORM_DELETE_CONFIRMATION_REQUIRED ReasonActive form requires confirm=true
HTTP422 CodeBITRIX_ERROR ReasonOther Bitrix24 refusal, original message retained
HTTP500 CodeCRM_FORM_SIDE_EFFECT_FAILED ReasonWrite already happened; read the form before retrying. On creation error.id identifies the saved form
HTTP502 CodeBITRIX_UNAVAILABLE ReasonInvalid or unavailable upstream response; re-read the form before retrying a write

Bitrix24 codes, statuses and messages are retained. See common limits for shared 429, 502 and 503 responses.