Add Service v 3.0 catalog.product.service.add

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: catalog

Who can execute the method: a user with the "Create product" permission and one of the "View product catalog", "View catalog products", or "Edit selling price" permissions

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The catalog.product.service.add method creates a service in the trade catalog and returns its fields.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

An object with the fields of the new service. Field description

Parameter fields

Required parameters are marked with *

Name
type

Description

iblockId*
integer

Identifier of the trade catalog information block. It cannot be changed after creation.

The identifier can be retrieved using the catalog.catalog.list method

name*
string

Name of the service

code
string

Symbolic code

xmlId
string

External code. If it is not passed, Bitrix24 writes the service identifier to the field

active
string

Service activity status.

Possible values:

  • Y — yes
  • N — no

Any value other than Y is saved as N.

Default: Y

sort
integer

Sort order.

Default: 500

createdBy
integer

Identifier of the user who created the service.

The identifier can be retrieved using the user.get method

modifiedBy
integer

Identifier of the user who last modified the service.

The identifier can be retrieved using the user.get method

dateActiveFrom
datetime

Activity start date in ISO 8601 format, for example 2026-11-01T10:00:00+02:00

dateActiveTo
datetime

Activity end date in ISO 8601 format

previewText
string

Preview description

previewTextType
string

Preview description type.

Possible values:

  • text — text
  • html — HTML

Default: text

previewPicture
object

Preview picture. An object in the format {"fileData": ["file_name.png", "base64 content"]}.

Currently the method accepts this object without an error but does not save the file: the field stays null in the response. You can upload a picture using the previous version method catalog.product.service.update

detailText
string

Detail description

detailTextType
string

Detail description type.

Possible values:

  • text — text
  • html — HTML

Default: text

detailPicture
object

Detail picture. An object in the format {"fileData": ["file_name.png", "base64 content"]}.

Currently the method accepts this object without an error but does not save the file: the field stays null in the response. You can upload a picture using the previous version method catalog.product.service.update

iblockSectionId
integer

Identifier of the main catalog section.

The identifier can be retrieved using the catalog.section.list method.

For a section that does not exist, the method returns an access error

iblockSection
array

An array of identifiers of the sections to link the service to, for example [31, 45]. If iblockSectionId is not passed, the first section in the array becomes the main one.

An empty array together with iblockSectionId: 0 unlinks the service from all sections

quantity
double

Quantity

quantityReserved
double

Reserved quantity

quantityTrace
string

Quantity tracking mode.

Possible values:

  • Y — yes
  • N — no
  • D — according to the catalog settings

canBuyZero
string

Allow purchase when out of stock.

Possible values:

  • Y — yes
  • N — no
  • D — according to the catalog settings

subscribe
string

Allow subscription to the product.

Possible values:

  • Y — yes
  • N — no
  • D — according to the catalog settings

vatId
integer

VAT rate identifier.

The identifier can be retrieved using the catalog.vat.list method

vatIncluded
string

Whether VAT is included in the price.

Possible values:

  • Y — yes
  • N — no

Default: N

purchasingPrice
double

Purchase price

purchasingCurrency
string

Currency code of the purchase price, for example EUR.

Currency codes can be retrieved using the crm.currency.list method

barcodeMulti
string

Unique barcodes for each item.

Possible values:

  • Y — yes
  • N — no

weight
double

Weight

length
double

Length

width
double

Width

height
double

Height

measure
integer

Unit of measurement identifier.

The identifier can be retrieved using the catalog.measure.list method

recurSchemeLength
integer

Payment period length. Used for content sales in the on-premise version

recurSchemeType
string

Time unit of the payment period.

Possible values:

  • H — hour
  • D — day
  • W — week
  • M — month
  • Q — quarter
  • S — half-year
  • Y — year
  • T — two years

Used for content sales in the on-premise version

trialPriceId
integer

Identifier of the product for a trial payment. Used for content sales in the on-premise version

withoutOrder
string

Renewal without placing an order.

Possible values:

  • Y — yes
  • N — no

Used for content sales in the on-premise version

quantityTraceRaw
string

Saved value of the quantity tracking mode.

Possible values:

  • Y — yes
  • N — no
  • D — according to the catalog settings

paymentType
string

Payment type.

Possible values:

  • S — one-time
  • R — recurring
  • T — trial

Used for content sales in the on-premise version

subscribeRaw
string

Saved value of the subscription permission.

Possible values:

  • Y — yes
  • N — no
  • D — according to the catalog settings

canBuyZeroRaw
string

Saved value of the out-of-stock purchase permission.

Possible values:

  • Y — yes
  • N — no
  • D — according to the catalog settings

properties
object

Service property values. The keys are PROPERTY_{id}, where {id} is the property identifier, for example {"PROPERTY_301": "SRV-001"}. For a multiple property, pass an array of values.

Property identifiers can be retrieved using the catalog.productProperty.list or catalog.product.fields.getbyfilter method

Bitrix24 sets the service type type itself. The id, dateCreate, timestampX, type, available, and bundle fields are read-only, and passing them causes an error. Set the service price using the catalog.price.add method.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.product.service.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"iblockId":25,"name":"Equipment installation","xmlId":"DOCS-V3-SERVICE-1","sort":100,"vatId":1,"vatIncluded":"Y","measure":9,"previewText":"Installation and connection of equipment","iblockSectionId":45,"properties":{"PROPERTY_301":"SRV-001"}}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.service.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"iblockId":25,"name":"Equipment installation","xmlId":"DOCS-V3-SERVICE-1","sort":100,"vatId":1,"vatIncluded":"Y","measure":9,"previewText":"Installation and connection of equipment","iblockSectionId":45,"properties":{"PROPERTY_301":"SRV-001"}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.service.add
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ServiceAddResult = {
          item: {
            id: number
            iblockId: number
            name: string
            xmlId: string | null
            active: 'Y' | 'N'
            sort: number
            type: number
            iblockSectionId: number | null
            vatId: number | null
            vatIncluded: 'Y' | 'N'
            measure: number | null
            previewText: string | null
            detailPicture: string | null
            timestampX: ISODate
            properties: Record<string, { VALUE: string, VALUE_ID: string } | Array<{ VALUE: string, VALUE_ID: string }> | null>
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ServiceAddResult>({
            method: 'catalog.product.service.add',
            params: {
              fields: {
                iblockId: 25,
                name: 'Equipment installation',
                xmlId: 'DOCS-V3-SERVICE-1',
                sort: 100,
                vatId: 1,
                vatIncluded: 'Y',
                measure: 9,
                previewText: 'Installation and connection of equipment',
                iblockSectionId: 45,
                properties: {
                  PROPERTY_301: 'SRV-001',
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Service created:', result.item.id)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function addService() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.service.add',
                params: {
                  fields: {
                    iblockId: 25,
                    name: 'Equipment installation',
                    xmlId: 'DOCS-V3-SERVICE-1',
                    sort: 100,
                    vatId: 1,
                    vatIncluded: 'Y',
                    measure: 9,
                    previewText: 'Installation and connection of equipment',
                    iblockSectionId: 45,
                    properties: {
                      PROPERTY_301: 'SRV-001',
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Service created:', result.item.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addService)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.service.add(
                fields={
                    "iblockId": 25,
                    "name": "Equipment installation",
                    "xmlId": "DOCS-V3-SERVICE-1",
                    "sort": 100,
                    "vatId": 1,
                    "vatIncluded": "Y",
                    "measure": 9,
                    "previewText": "Installation and connection of equipment",
                    "iblockSectionId": 45,
                    "properties": {
                        "PROPERTY_301": "SRV-001",
                    },
                },
            ).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}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.product.service.add',
                    [
                        'fields' => [
                            'iblockId' => 25,
                            'name' => 'Equipment installation',
                            'xmlId' => 'DOCS-V3-SERVICE-1',
                            'sort' => 100,
                            'vatId' => 1,
                            'vatIncluded' => 'Y',
                            'measure' => 9,
                            'previewText' => 'Installation and connection of equipment',
                            'iblockSectionId' => 45,
                            'properties' => [
                                'PROPERTY_301' => 'SRV-001',
                            ],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'catalog.product.service.add',
            {
                fields: {
                    iblockId: 25,
                    name: 'Equipment installation',
                    xmlId: 'DOCS-V3-SERVICE-1',
                    sort: 100,
                    vatId: 1,
                    vatIncluded: 'Y',
                    measure: 9,
                    previewText: 'Installation and connection of equipment',
                    iblockSectionId: 45,
                    properties: {
                        PROPERTY_301: 'SRV-001',
                    },
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.product.service.add',
            [
                'fields' => [
                    'iblockId' => 25,
                    'name' => 'Equipment installation',
                    'xmlId' => 'DOCS-V3-SERVICE-1',
                    'sort' => 100,
                    'vatId' => 1,
                    'vatIncluded' => 'Y',
                    'measure' => 9,
                    'previewText' => 'Installation and connection of equipment',
                    'iblockSectionId' => 45,
                    'properties' => [
                        'PROPERTY_301' => 'SRV-001',
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.product.service.add", b24.Params{
        	"fields": b24.Params{
        		"iblockId":        25,
        		"name":            "Equipment installation",
        		"xmlId":           "DOCS-V3-SERVICE-1",
        		"sort":            100,
        		"vatId":           1,
        		"vatIncluded":     "Y",
        		"measure":         9,
        		"previewText":     "Installation and connection of equipment",
        		"iblockSectionId": 45,
        		"properties":      b24.Params{
        			"PROPERTY_301": "SRV-001",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.product.service.add: %w", err)
        }
        
        // The method wraps the response in an object with the "item" key.
        raw, ok := b24.Unwrap(res.Result, "item")
        if !ok {
        	return fmt.Errorf("no item key in the response")
        }
        
        var item struct {
        	ID      int    `json:"id"`
        	Name    string `json:"name"`
        	Type    int    `json:"type"`
        	Measure int    `json:"measure"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.Type)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 7551,
                    "iblockId": 25,
                    "name": "Equipment installation",
                    "code": null,
                    "xmlId": "DOCS-V3-SERVICE-1",
                    "active": "Y",
                    "sort": 100,
                    "createdBy": 1,
                    "modifiedBy": 1,
                    "dateCreate": "2026-10-22T12:18:35+02:00",
                    "timestampX": "2026-10-22T12:18:35+02:00",
                    "dateActiveFrom": null,
                    "dateActiveTo": null,
                    "previewText": "Installation and connection of equipment",
                    "previewTextType": "text",
                    "previewPicture": null,
                    "detailText": null,
                    "detailTextType": "text",
                    "detailPicture": null,
                    "iblockSectionId": 45,
                    "iblockSection": [
                        45
                    ],
                    "type": 7,
                    "available": "N",
                    "bundle": "N",
                    "quantity": 0,
                    "quantityReserved": 0,
                    "quantityTrace": "N",
                    "canBuyZero": "Y",
                    "subscribe": "Y",
                    "vatId": 1,
                    "vatIncluded": "Y",
                    "purchasingPrice": null,
                    "purchasingCurrency": null,
                    "barcodeMulti": "N",
                    "weight": 0,
                    "length": null,
                    "width": null,
                    "height": null,
                    "measure": 9,
                    "recurSchemeLength": null,
                    "recurSchemeType": "D",
                    "trialPriceId": null,
                    "withoutOrder": "N",
                    "quantityTraceRaw": "N",
                    "paymentType": "S",
                    "subscribeRaw": "D",
                    "canBuyZeroRaw": "Y",
                    "properties": {
                        "PROPERTY_309": null,
                        "PROPERTY_293": null,
                        "PROPERTY_295": null,
                        "PROPERTY_297": null,
                        "PROPERTY_299": null,
                        "PROPERTY_301": {
                            "VALUE": "SRV-001",
                            "VALUE_ID": "4017"
                        },
                        "PROPERTY_303": null,
                        "PROPERTY_305": null,
                        "PROPERTY_307": null,
                        "PROPERTY_311": null,
                        "PROPERTY_313": null,
                        "PROPERTY_315": null,
                        "PROPERTY_329": null,
                        "PROPERTY_343": null,
                        "PROPERTY_359": null,
                        "PROPERTY_431": null,
                        "PROPERTY_433": null,
                        "PROPERTY_435": null,
                        "PROPERTY_893": null,
                        "PROPERTY_897": null,
                        "PROPERTY_901": null,
                        "PROPERTY_917": null,
                        "PROPERTY_921": null,
                        "PROPERTY_931": null,
                        "PROPERTY_933": null,
                        "PROPERTY_935": null,
                        "PROPERTY_1013": null,
                        "PROPERTY_1015": null,
                        "PROPERTY_1019": null,
                        "PROPERTY_1021": null,
                        "PROPERTY_1023": null,
                        "PROPERTY_1077": null,
                        "PROPERTY_1079": null,
                        "PROPERTY_1081": null,
                        "PROPERTY_1083": null,
                        "PROPERTY_1085": null,
                        "PROPERTY_1231": null
                    }
                }
            },
            "time": {
                "start": 1792660715,
                "finish": 1792660715.19402,
                "duration": 0.19402003288269043,
                "processing": 0,
                "date_start": "2026-10-22T12:18:35+02:00",
                "date_finish": "2026-10-22T12:18:35+02:00",
                "operating_reset_at": 1792660920,
                "operating": 0.25499987602233887
            }
        }
        

Returned Data

Name
type

Description

result
object

An object with the response data

result.item
object

Service fields. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Service identifier

iblockId
integer

Identifier of the trade catalog information block

name
string

Name of the service

code
string

Symbolic code

xmlId
string

External code. If the code was not passed on creation, it equals the service identifier

active
string

Service activity status: Y — active, N — inactive

sort
integer

Sort order

createdBy
integer

Identifier of the user who created the service

modifiedBy
integer

Identifier of the user who last modified the service

dateCreate
datetime

Creation date and time

timestampX
datetime

Date and time of the last modification

dateActiveFrom
datetime

Activity start date

dateActiveTo
datetime

Activity end date

previewText
string

Preview description

previewTextType
string

Preview description type: text or html

previewPicture
string

Preview picture file identifier as a string. null if there is no picture

detailText
string

Detail description

detailTextType
string

Detail description type: text or html

detailPicture
string

Detail picture file identifier as a string. null if there is no picture. The file can be retrieved using the catalog.product.service.download method

iblockSectionId
integer

Main section identifier. null if the service is not linked to a section

iblockSection
array

An array of identifiers of all sections the service is linked to

type
integer

Product type. Always 7 for a service

available
string

Available for purchase: Y — yes, N — no

bundle
string

Set flag: Y — yes, N — no

quantity
double

Quantity

quantityReserved
double

Reserved quantity

quantityTrace
string

Effective quantity tracking mode, taking the catalog settings into account: Y — enabled, N — disabled

canBuyZero
string

Effective out-of-stock purchase permission, taking the catalog settings into account: Y — yes, N — no

subscribe
string

Effective subscription permission, taking the catalog settings into account: Y — yes, N — no

vatId
integer

VAT rate identifier. null if no rate is set

vatIncluded
string

VAT is included in the price: Y — yes, N — no

purchasingPrice
double

Purchase price. null if not set

purchasingCurrency
string

Purchase price currency. null if not set

barcodeMulti
string

Unique barcodes for each item: Y — yes, N — no

weight
double

Weight

length
double

Length. null if not set

width
double

Width. null if not set

height
double

Height. null if not set

measure
integer

Unit of measurement identifier

recurSchemeLength
integer

Payment period length. Used for content sales in the on-premise version

recurSchemeType
string

Time unit of the payment period, for example D — day. Used for content sales in the on-premise version

trialPriceId
integer

Identifier of the product for a trial payment. Used for content sales in the on-premise version

withoutOrder
string

Renewal without placing an order: Y — yes, N — no

quantityTraceRaw
string

Saved value of the quantity tracking mode: Y, N, or D — according to the catalog settings

paymentType
string

Payment type: S — one-time, R — recurring, T — trial

subscribeRaw
string

Saved value of the subscription permission: Y, N, or D — according to the catalog settings

canBuyZeroRaw
string

Saved value of the out-of-stock purchase permission: Y, N, or D — according to the catalog settings

properties
object

Service property values. The keys are PROPERTY_{id}, where {id} is the property identifier. A property value is an object {"VALUE": "...", "VALUE_ID": "..."}, and for a multiple property it is an array of such objects. null if no value is set

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "productType is not allowed for this catalog"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object

200040300000

Iblock Not Found

Pass the identifier of an existing trade catalog. The list of catalogs is returned by the catalog.catalog.list method

-

iblock is not catalog

The information block is not a trade catalog. Pass the identifier of a trade catalog

-

productType is not allowed for this catalog

A service cannot be created in an offers catalog. Pass the identifier of a product catalog

-

VAT vatId is not exists

Pass the identifier of an existing VAT rate. The rates are returned by the catalog.vat.list method

-

Currency purchasingCurrency is not exists

Pass the code of an existing currency

-

User createdBy is not exists

Pass the identifier of an existing user in createdBy

-

User modifiedBy is not exists

Pass the identifier of an existing user in modifiedBy

-

The properties field accepts only the property keys PROPERTY_{id}, unknown keys: #KEYS#

Pass property keys in the PROPERTY_{id} format, for example PROPERTY_301

-

The properties field names one property by several keys: #KEYS#

Pass each property with a single key

#FIELD#

This request requires data type #TYPE# in field #FIELD#

Pass a value of the required type

-

Internal error adding product. Try adding again.

Repeat the request

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

name

Required field name is empty

Pass the service name in fields.name

iblockId

Required field iblockId is empty

Pass the catalog identifier in fields.iblockId

#FIELD#

Field #FIELD# is read-only

Remove the read-only fields from fields: id, dateCreate, timestampX, type, available, bundle

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity ProductDto

Pass only the fields from the Parameter fields table in fields

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP status: 403

Field

Error description

How to Fix

-

Access denied

Check the user's permissions. The error is also returned if the section from iblockSectionId does not exist: check the identifier using the catalog.section.list method

Statuses and System Error Codes

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