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

Submit visitor values

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

Submits a CRM form result on behalf of a visitor. This is a write: Bitrix24 may create a lead or deal, start automation and notify responsible users. It does not change form configuration.

Scope: crm. Requires a READWRITE key.

Parameters

id is a positive form ID from list forms.

Body field Type Required Description
Body fieldfields Typeobject Requiredyes DescriptionNon-empty values object. Keys are native field names such as LEAD_NAME, LEAD_PHONE. See get a form for its fields
Body fieldpresets Typeobject Requiredno DescriptionPreset values, forwarded to Bitrix24 without transformation
Body fieldfromUrl Typestring Requiredno DescriptionAddress of the page where the form was completed

Other parameters are rejected. Bitrix24 validates the fields and their values; this method does not support file fields.

Example

Terminal 
curl -X POST 'https://vibecode.bitrix24.com/v1/crm-forms/8/results' \
  -H 'X-Api-Key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"fields":{"LEAD_NAME":"Alex","LEAD_PHONE":"+12025550123"},"fromUrl":"https://example.com/contact"}'

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

Success is HTTP 201:

JSON 
{"success":true,"data":{"resultId":227}}

resultId identifies the CRM form result, not the lead or deal it created.

Errors

HTTP Code Reason
HTTP400 CodeMISSING_REQUIRED_FIELDS Reasonfields is absent, empty or not an object
HTTP400 CodeINVALID_PARAMS ReasonInvalid id, body shape, presets, fromUrl or an extra parameter
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY ReasonREADONLY key
HTTP403 CodeSCOPE_DENIED ReasonMissing crm scope
HTTP403 CodeBITRIX_ACCESS_DENIED ReasonBitrix24 refused access
HTTP404 CodeENTITY_NOT_FOUND ReasonForm not found.
HTTP422 CodeBITRIX_ERROR ReasonForm is not active., a field validation error or an unsupported file field; the Bitrix24 message is retained
HTTP502 CodeBITRIX_RESPONSE_INVALID ReasonBitrix24 returned no valid result ID

Do not retry blindly after a disconnected request or ambiguous response: the result may have been saved and triggered automation. Automatic write retries are disabled.

See limits for common errors and rate limits. To send a form link to a customer, see Send a CRM form to a customer.