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

Deactivate a form

POST /v1/crm-forms/:id/deactivate

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

Scope: crm. Requires a READWRITE key.

Behavior and parameters

Deactivates a form. An optional updatedTime enables optimistic locking. The response contains the actual active and updatedTime values. Bitrix24 refuses changes to system forms, including deactivation.

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

Example

Terminal 
curl -X POST 'https://vibecode.bitrix24.com/v1/crm-forms/8/deactivate' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

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

JSON 
{"success":true,"data":{"active":false,"updatedTime":"2026-10-22T12:00:00Z"}}

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
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.