Update Commercial Estimate crm.quote.update

Scope: crm

Who can execute the method: a user with "edit" access permission for estimates

Method Development Halted

The method crm.quote.update continues to function, but there is a more current alternative, crm.item.update.

The method crm.quote.update updates an existing estimate.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Identifier of the estimate.

The identifier can be obtained using the methods crm.quote.list and crm.quote.add

fields
object

Object format:

{
            "field_1": "value_1",
            "field_2": "value_2",
            "...": "..."
        }
        

where:

  • field_n — field name
  • value_n — new field value

Only include the fields that need to be changed in fields.

Unknown fields in fields are ignored.

The list of primary fields for updating is provided below.

A complete list of fields and types can be obtained using the method crm.quote.fields

params
object

Object of additional parameters (detailed description)

Parameter fields

Name
type

Description

TITLE
string

Subject of the estimate.

Length restriction — up to 255 characters.

If a value longer than 255 is provided, the system will truncate it to 255 characters

STATUS_ID
crm_status

Stage of the estimate.

The list of available stages can be obtained using the method crm.status.list with the filter ENTITY_ID = QUOTE_STATUS

CURRENCY_ID
crm_currency

Currency of the estimate amount

OPPORTUNITY
double

Amount of the estimate

ASSIGNED_BY_ID
user

Identifier of the responsible person

COMPANY_ID
crm_company

Identifier of the client company

CONTACT_IDS
crm_contact[]

Array of identifiers for client contacts.

The field is completely replaced

MYCOMPANY_ID
crm_company

Identifier of "your company" for vendor details

OPENED
char

Is the estimate available to everyone? Possible values:

  • Y — yes
  • N — no

PERSON_TYPE_ID
integer

Identifier of the client type

BEGINDATE
date

Date of issue

CLOSEDATE
date

Expiration date of the estimate

CLIENT_TITLE
string

Client name, up to 255 characters

CLIENT_ADDR
string

Client address, up to 255 characters

CLIENT_EMAIL
string

Client email, up to 255 characters

CLIENT_PHONE
string

Client phone, up to 255 characters

COMMENTS
string

Comment

PARENT_ID_...
crm_entity

Fields for links to smart processes.

For example, PARENT_ID_136 — link to the smart process entityTypeId = 136

Method Feature

Some incorrect values in the fields may not lead to a 400 error: values are normalized, truncated, or replaced with default values.

Parameter params

Name
type

Description

REGISTER_HISTORY_EVENT
boolean

Should a record be created in the change history? Possible values:

  • Y — yes
  • N — no

Default — Y

Code Examples

How to Use Examples in Documentation

Example of updating an estimate:

  • estimate identifier — 43
  • new stage — SENT
  • updated comment — Terms and conditions clarified
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":43,"fields":{"STATUS_ID":"SENT","COMMENTS":"Terms and conditions clarified"},"params":{"REGISTER_HISTORY_EVENT":"Y"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.quote.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":43,"fields":{"STATUS_ID":"SENT","COMMENTS":"Terms and conditions clarified"},"params":{"REGISTER_HISTORY_EVENT":"Y"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.quote.update
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.quote.update',
        		{
        			id: 43,
        			fields: {
        				STATUS_ID: 'SENT',
        				COMMENTS: 'Terms and conditions clarified',
        			},
        			params: {
        				REGISTER_HISTORY_EVENT: 'Y',
        			},
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.quote.update',
                    [
                        'id' => 43,
                        'fields' => [
                            'STATUS_ID' => 'SENT',
                            'COMMENTS' => 'Terms and conditions clarified',
                        ],
                        'params' => [
                            'REGISTER_HISTORY_EVENT' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Updated: ' . ($result ? 'true' : 'false');
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating quote: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.quote.update',
            {
                id: 43,
                fields: {
                    STATUS_ID: 'SENT',
                    COMMENTS: 'Terms and conditions clarified',
                },
                params: {
                    REGISTER_HISTORY_EVENT: 'Y',
                },
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.quote.update',
            [
                'id' => 43,
                'fields' => [
                    'STATUS_ID' => 'SENT',
                    'COMMENTS' => 'Terms and conditions clarified',
                ],
                'params' => [
                    'REGISTER_HISTORY_EVENT' => 'Y',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1773410167,
                "finish": 1773410167.690598,
                "duration": 0.6905980110168457,
                "processing": 0,
                "date_start": "2026-03-13T16:56:07+01:00",
                "date_finish": "2026-03-13T16:56:07+01:00",
                "operating_reset_at": 1773410767,
                "operating": 0.26904988288879395
            }
        }
        

Returned Data

Name
type

Description

result
boolean

Root element of the response, returns true on success

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "",
            "error_description": "Quote is not found"
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

Value

-

Parameter 'fields' must be array.

fields is not an object

-

Parameter 'params' must be array.

params is not an object

-

ID is not defined or invalid.

Invalid id provided

-

Access denied.

User does not have permission to edit estimates

-

Quote is not found

Estimate with the provided id was not found

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning