Update Order Property sale.property.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: sale

Who can execute the method: administrator

The method sale.property.update updates the order property.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
sale_order_property.id

Identifier of the order property

fields*
object

Field values for creating the order property

Parameter fields

General parameters relevant for order properties of any type:

Required parameters are marked with *

Name
type

Description

name*
string

Name of the order property

code
string

Symbolic code of the order property

active
string

Indicator of the order property’s activity.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is Y

util
string

Indicator of whether the order property is a service property. Service properties are not displayed in the public part.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

userProps
string

Indicator of whether the order property is included in the customer profile.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isFiltered
string

Indicator of whether the order property is available in the filter on the order list page.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

sort
integer

Sorting

description
string

Description of the order property

required
string

Indicator of whether filling in the order property value is mandatory.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

multiple
string

Indicator of whether the order property is multiple. For multiple properties, it is possible to specify several values.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

xmlId
string

External identifier of the order property

defaultValue
any

Default value of the order property.

For properties of type file, you need to provide an object in the format {"fileData": ["value1", "value2"]}:

  • value1 — file name with extension,
  • value2 — file in base64 format.

To delete a file, use the object in the format {"remove": "Y"}.

For multiple order properties (multiple), it supports passing an array of values.
To delete a value, you need to pass null, or simply not pass the parameter.

settings
object

An object in the format {"field_1": "value_1", ... "field_N": "value_N"} for passing additional settings for the order property.

The list of supported keys for this object depends on the type of property. For some property types (e.g., Y/N), additional properties are not provided. The description of the settings parameter for different property types is provided in the method description sale.property.add

Parameters relevant for order properties of type STRING

Name
type

Description

isProfileName
string

Indicator of whether to use the value of this order property as the user profile name.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isPayer
string

Indicator of whether to use the value of this order property as the payer's name.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isEmail
string

Indicator of whether to use the value of this order property as an e-mail (e.g., when registering a new user during checkout).
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isPhone
string

Indicator of whether to use the value of this order property as a phone number.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isZip
string

Indicator of whether to use the value of this order property as a postal code.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isAddress
string

Indicator of whether to use the value of this order property as an address.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

Parameters relevant for order properties of type LOCATION

Name
type

Description

isLocation
string

Indicator of whether to use the value of this order property as the buyer's location for calculating delivery costs.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isLocation4tax
string

Indicator of whether to use the value of this order property as the buyer's location for determining tax rates.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

inputFieldLocation
string

Deprecated field. Not used.

Parameters relevant for order properties of type ADDRESS

Name
type

Description

isAddressFrom
string

Indicator of whether to use the value of this order property as the buyer's address from where the order needs to be picked up for calculating delivery costs.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

isAddressTo
string

Indicator of whether to use the value of this order property as the buyer's address where the order needs to be delivered for calculating delivery costs.
Possible values:

  • Y — yes
  • N — no

If not provided, the default value is N

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":93,"fields":{"personTypeId":3,"propsGroupId":6,"name":"Phone (for contacting the courier)","type":"STRING","code":"PHONE","active":"Y","util":"N","userProps":"Y","isFiltered":"N","sort":500,"description":"property description","required":"Y","multiple":"N","settings":{"multiline":"Y","maxlength":100},"xmlId":"","defaultValue":"","isProfileName":"Y","isPayer":"Y","isEmail":"N","isPhone":"N","isZip":"N","isAddress":"N"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.property.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":93,"fields":{"personTypeId":3,"propsGroupId":6,"name":"Phone (for contacting the courier)","type":"STRING","code":"PHONE","active":"Y","util":"N","userProps":"Y","isFiltered":"N","sort":500,"description":"property description","required":"Y","multiple":"N","settings":{"multiline":"Y","maxlength":100},"xmlId":"","defaultValue":"","isProfileName":"Y","isPayer":"Y","isEmail":"N","isPhone":"N","isZip":"N","isAddress":"N"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.property.update
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type PropertyUpdateResult = {
          property: {
            id: number
            active: string
            code: string
            defaultValue: string
            description: string
            inputFieldLocation: string
            isAddress: string
            isAddressFrom: string
            isAddressTo: string
            isEmail: string
            isFiltered: string
            isLocation: string
            isLocation4tax: string
            isPayer: string
            isPhone: string
            isProfileName: string
            isZip: string
            multiple: string
            name: string
            personTypeId: number
            propsGroupId: number
            required: string
            settings: Record<string, string>
            sort: number
            type: string
            userProps: string
            util: string
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<PropertyUpdateResult>({
            method: 'sale.property.update',
            params: {
              id: 93,
              fields: {
                personTypeId: 3,
                propsGroupId: 6,
                name: 'Phone (courier contact)',
                type: 'STRING',
                code: 'PHONE',
                active: 'Y',
                util: 'N',
                userProps: 'Y',
                isFiltered: 'N',
                sort: 500,
                description: 'property description',
                required: 'Y',
                multiple: 'N',
                settings: {
                  multiline: 'Y',
                  maxlength: 100,
                },
                xmlId: '',
                defaultValue: '',
                isProfileName: 'Y',
                isPayer: 'Y',
                isEmail: 'N',
                isPhone: 'N',
                isZip: 'N',
                isAddress: 'N',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Updated property:', result.property.id, result.property.name)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateSaleProperty() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'sale.property.update',
                params: {
                  id: 93,
                  fields: {
                    personTypeId: 3,
                    propsGroupId: 6,
                    name: 'Phone (courier contact)',
                    type: 'STRING',
                    code: 'PHONE',
                    active: 'Y',
                    util: 'N',
                    userProps: 'Y',
                    isFiltered: 'N',
                    sort: 500,
                    description: 'property description',
                    required: 'Y',
                    multiple: 'N',
                    settings: {
                      multiline: 'Y',
                      maxlength: 100,
                    },
                    xmlId: '',
                    defaultValue: '',
                    isProfileName: 'Y',
                    isPayer: 'Y',
                    isEmail: 'N',
                    isPhone: 'N',
                    isZip: 'N',
                    isAddress: 'N',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Updated property:', result.property.id, result.property.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSaleProperty)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        fields = {
            "personTypeId": 3,
            "propsGroupId": 6,
            "name": "Phone (to contact the courier)",
            "type": "STRING",
            "code": "PHONE",
            "active": "Y",
            "util": "N",
            "userProps": "Y",
            "isFiltered": "N",
            "sort": 500,
            "description": "property description",
            "required": "Y",
            "multiple": "N",
            "settings": {
                "multiline": "Y",
                "maxlength": 100,
            },
            "xmlId": "",
            "defaultValue": "",
            "isProfileName": "Y",
            "isPayer": "Y",
            "isEmail": "N",
            "isPhone": "N",
            "isZip": "N",
            "isAddress": "N",
        }
        
        try:
            bitrix_response = client.sale.property.update(
                bitrix_id=93,
                fields=fields,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.property.update',
                    [
                        'id' => 93,
                        'fields' => [
                            'personTypeId'  => 3,
                            'propsGroupId'  => 6,
                            'name'          => 'Phone (for contacting the courier)',
                            'type'          => 'STRING',
                            'code'          => 'PHONE',
                            'active'        => 'Y',
                            'util'          => 'N',
                            'userProps'     => 'Y',
                            'isFiltered'    => 'N',
                            'sort'          => 500,
                            'description'   => 'property description',
                            'required'      => 'Y',
                            'multiple'      => 'N',
                            'settings'      => [
                                'multiline' => 'Y',
                                'maxlength' => 100,
                            ],
                            'xmlId'         => '',
                            'defaultValue'  => '',
                            'isProfileName' => 'Y',
                            'isPayer'       => 'Y',
                            'isEmail'       => 'N',
                            'isPhone'       => 'N',
                            'isZip'         => 'N',
                            'isAddress'     => 'N',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating sale property: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.property.update', {
                id: 93,
                fields: {
                    personTypeId: 3,
                    propsGroupId: 6,
                    name: 'Phone (for contacting the courier)',
                    type: 'STRING',
                    code: 'PHONE',
                    active: 'Y',
                    util: 'N',
                    userProps: 'Y',
                    isFiltered: 'N',
                    sort: 500,
                    description: 'property description',
                    required: 'Y',
                    multiple: 'N',
                    settings: {
                        multiline: 'Y',
                        maxlength: 100
                    },
                    xmlId: '',
                    defaultValue: '',
                    isProfileName: 'Y',
                    isPayer: 'Y',
                    isEmail: 'N',
                    isPhone: 'N',
                    isZip: 'N',
                    isAddress: 'N',
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.property.update',
            [
                'id' => 93,
                'fields' => [
                    'personTypeId' => 3,
                    'propsGroupId' => 6,
                    'name' => 'Phone (for contacting the courier)',
                    'type' => 'STRING',
                    'code' => 'PHONE',
                    'active' => 'Y',
                    'util' => 'N',
                    'userProps' => 'Y',
                    'isFiltered' => 'N',
                    'sort' => 500,
                    'description' => 'property description',
                    'required' => 'Y',
                    'multiple' => 'N',
                    'settings' => [
                        'multiline' => 'Y',
                        'maxlength' => 100
                    ],
                    'xmlId' => '',
                    'defaultValue' => '',
                    'isProfileName' => 'Y',
                    'isPayer' => 'Y',
                    'isEmail' => 'N',
                    'isPhone' => 'N',
                    'isZip' => 'N',
                    'isAddress' => 'N',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.property.update", b24.Params{
        	"id": 93,
        	"fields": b24.Params{
        		"personTypeId": 3,
        		"propsGroupId": 6,
        		"name":         "Phone (for contacting the courier)",
        		"type":         "STRING",
        		"code":         "PHONE",
        		"active":       "Y",
        		"util":         "N",
        		"userProps":    "Y",
        		"isFiltered":   "N",
        		"sort":         500,
        		"description":  "property description",
        		"required":     "Y",
        		"multiple":     "N",
        		"settings": b24.Params{
        			"multiline": "Y",
        			"maxlength": 100,
        		},
        		"xmlId":         "",
        		"defaultValue":  "",
        		"isProfileName": "Y",
        		"isPayer":       "Y",
        		"isEmail":       "N",
        		"isPhone":       "N",
        		"isZip":         "N",
        		"isAddress":     "N",
        	},
        })
        if err != nil {
        	return fmt.Errorf("sale.property.update: %w", err)
        }
        
        // The method wraps the response in an object with the "property" key.
        raw, ok := b24.Unwrap(res.Result, "property")
        if !ok {
        	return fmt.Errorf("no property key in the response")
        }
        
        var item struct {
        	Active             string `json:"active"`
        	Code               string `json:"code"`
        	DefaultValue       string `json:"defaultValue"`
        	Description        string `json:"description"`
        	ID                 b24.ID `json:"id"`
        	InputFieldLocation string `json:"inputFieldLocation"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Active, item.Code)

Response on Success

HTTP Status: 200

{
           "result":{
              "property":{
                 "active":"Y",
                 "code":"PHONE",
                 "defaultValue":"",
                 "description":"property description",
                 "id":96,
                 "inputFieldLocation":"0",
                 "isAddress":"N",
                 "isAddressFrom":"N",
                 "isAddressTo":"N",
                 "isEmail":"N",
                 "isFiltered":"N",
                 "isLocation":"N",
                 "isLocation4tax":"N",
                 "isPayer":"Y",
                 "isPhone":"N",
                 "isProfileName":"Y",
                 "isZip":"N",
                 "multiple":"N",
                 "name":"Phone (for contacting the courier)",
                 "personTypeId":3,
                 "propsGroupId":6,
                 "required":"Y",
                 "settings":{
                    "maxlength":"100",
                    "multiline":"Y"
                 },
                 "sort":500,
                 "type":"STRING",
                 "userProps":"Y",
                 "util":"N",
                 "xmlId":""
              }
           },
           "time":{
              "start":1712818736.235335,
              "finish":1712818736.611224,
              "duration":0.3758888244628906,
              "processing":0.18679594993591309,
              "date_start":"2024-04-11T09:58:56+02:00",
              "date_finish":"2024-04-11T09:58:56+02:00"
           }
        }

Returned Data

Name
type

Description

result
object

Root element of the response

property
sale_order_property

Object containing information about the updated order property

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
           "error":200840400001,
           "error_description":"property does not exist"
        }

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

200840400001

The order property being updated was not found

200850000003

Internal error updating the property

200850000009

Error occurs when trying to update an order property with the multiple parameter set to Y, if the isFiltered parameter is not provided.
Filtering by multiple order properties is not supported

200850000010

Error occurs when trying to update an order property with the multiple parameter set to Y, if the isFiltered parameter is not equal to N.
Filtering by multiple order properties is not supported

200850000011

Error occurs when trying to update an order property of type LOCATION with the isLocation parameter set to Y, if the multiple parameter is not specified.
Multiplicity is not supported for order properties marked with the isLocation indicator

200850000012

Error occurs when trying to update an order property of type LOCATION with the isLocation parameter set to Y, if the multiple parameter is not equal to N.
Multiplicity is not supported for order properties marked with the isLocation indicator

200850000013

Error occurs when trying to update an order property of type LOCATION with the isLocation4tax parameter set to Y, if the multiple parameter is not specified.
Multiplicity is not supported for order properties marked with the isLocation4tax indicator

200850000014

Error occurs when trying to update an order property of type LOCATION with the isLocation4tax parameter set to Y, if the multiple parameter is not equal to N.
Multiplicity is not supported for order properties marked with the isLocation4tax indicator

200850000015

Error occurs when trying to update an order property of type STRING with the isProfileName parameter set to Y, if the required parameter is not specified.
Profile name is mandatory and cannot be empty

200850000016

Error occurs when trying to update an order property of type STRING with the isProfileName parameter set to Y, if the required parameter is not equal to Y.
Profile name is mandatory and cannot be empty

200040300020

Insufficient permissions to update the order property

100

The id parameter is not specified

100

The fields parameter is not specified or is empty

0

Required fields are not provided

0

Other errors (e.g., fatal errors)

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Continue Learning

Previous
Add Order Property
Next
Get Order Property Value