Add a New Resource Type booking.v1.resourceType.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: booking

Who can execute the method: any user

The method booking.v1.resourceType.add adds a new resource type.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

An object containing field values for creating a resource type (detailed description)

Parameter fields

Name
type

Description

name*
string

Resource type name

code*
string

Symbolic code of the resource type. Must be unique among the types of the booking module.

Codes of the predefined types: doctor, equipment, expert, car, room

isInfoNotificationOn
string

Booking message to the client. Possible values:

  • Y — enabled
  • N — disabled

Default is Y

isConfirmationNotificationOn
string

Message to the client requesting booking confirmation. Possible values:

  • Y — enabled
  • N — disabled

Default is Y

templateTypeConfirmation
string

Message template type for booking confirmation. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for booking with specialists
  • inanimate_long — template for multi-day booking

Default is inanimate

isReminderNotificationOn
string

Booking reminder. Possible values:

  • Y — enabled
  • N — disabled

Default is Y

templateTypeReminder
string

Message template type for the reminder. The only value is base

isFeedbackNotificationOn
string

Feedback request. Possible values:

  • Y — enabled
  • N — disabled

Default is Y

templateTypeFeedback
string

Message template type for the feedback request. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for booking with specialists

Default is inanimate

isDelayedNotificationOn
string

Reminder when the client is running late. Possible values:

  • Y — enabled
  • N — disabled

Default is Y

templateTypeDelayed
string

Message template type for late arrival. Possible values:

  • inanimate — template for booking equipment and rooms
  • animate — template for booking with specialists

Default is inanimate

isCancellationNotificationOn
string

Message to the client after a booking is cancelled. Possible values:

  • Y — enabled
  • N — disabled

Default is Y

cancellationNotificationDelay
integer

Time after a booking is cancelled, after which the client receives the cancellation message. Specified in seconds.

Default is 600

infoNotificationDelay
integer

Time after which the client receives the booking message. Specified in seconds.

Default is 0

reminderNotificationDelay
integer

Time before the booking, at which the client receives the reminder. Specified in seconds.

The value -1 means the reminder arrives on the morning of the booking day.

Default is -1

delayedNotificationDelay
integer

Time after which the late arrival message is sent to the client. Specified in seconds.

Default is 300

delayedCounterDelay
integer

Time after which the counter is activated in the calendar. Specified in seconds.

Default is 300

confirmationNotificationDelay
integer

Time before the booking, when the client receives the first confirmation message. Specified in seconds.

Default is 86400

confirmationNotificationRepetitions
integer

Number of confirmation messages sent to the client, excluding the first one.

Default is 0

confirmationNotificationRepetitionsInterval
integer

Interval between booking confirmation messages. Specified in seconds.

Default is 10800

confirmationCounterDelay
integer

Time before the booking, after which the unconfirmed booking counter is activated. Specified in seconds.

Default is 10800

senderCode
string

Code of the service that sends messages to the client. Possible values:

  • bitrix24 — Bitrix24 notifications
  • ai_call — AI agent call

The method does not validate the value: the codes listed are the ones Bitrix24 supports.

The field is retained on the type but has no effect on sending: Bitrix24 picks the sender by the senderCode field of the resource. Set it using the booking.v1.resource.add method.

By default, the field is empty

Fields with the Y and N flags accept strings only. The method silently ignores values of other types, such as true, and fields absent from the table.

The booking message template templateTypeInfo cannot be set for a resource type via REST: the field is not part of the resource type and the method ignores it. Set the template on the resource itself using the booking.v1.resource.add method.

Type configurations are not transferred to the resources of that type: a resource receives its own default values when created.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Name","code":"code","isInfoNotificationOn":"Y","templateTypeInfo":"inanimate","isConfirmationNotificationOn":"Y","templateTypeConfirmation":"animate","isReminderNotificationOn":"N","templateTypeReminder":"base","isFeedbackNotificationOn":"Y","templateTypeFeedback":"inanimate","isDelayedNotificationOn":"Y","templateTypeDelayed":"inanimate","infoNotificationDelay":300,"reminderNotificationDelay":-1,"delayedNotificationDelay":300,"delayedCounterDelay":7200,"confirmationNotificationDelay":86400,"confirmationNotificationRepetitions":0,"confirmationNotificationRepetitionsInterval":0,"confirmationCounterDelay":7200}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resourceType.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Name","code":"code","isInfoNotificationOn":"Y","templateTypeInfo":"inanimate","isConfirmationNotificationOn":"Y","templateTypeConfirmation":"animate","isReminderNotificationOn":"N","templateTypeReminder":"base","isFeedbackNotificationOn":"Y","templateTypeFeedback":"inanimate","isDelayedNotificationOn":"Y","templateTypeDelayed":"inanimate","infoNotificationDelay":300,"reminderNotificationDelay":-1,"delayedNotificationDelay":300,"delayedCounterDelay":7200,"confirmationNotificationDelay":86400,"confirmationNotificationRepetitions":0,"confirmationNotificationRepetitionsInterval":0,"confirmationCounterDelay":7200},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/booking.v1.resourceType.add
        
// 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 ResourceTypeAddResult = {
          id: number
        }
        
        try {
          const response = await $b24.actions.v2.call.make<ResourceTypeAddResult>({
            method: 'booking.v1.resourceType.add',
            params: {
              fields: {
                name: 'Equipment Room',
                code: 'code',
                isInfoNotificationOn: 'Y',
                templateTypeInfo: 'inanimate',
                isConfirmationNotificationOn: 'Y',
                templateTypeConfirmation: 'animate',
                isReminderNotificationOn: 'N',
                templateTypeReminder: 'base',
                isFeedbackNotificationOn: 'Y',
                templateTypeFeedback: 'inanimate',
                isDelayedNotificationOn: 'Y',
                templateTypeDelayed: 'inanimate',
                infoNotificationDelay: 300,
                reminderNotificationDelay: -1,
                delayedNotificationDelay: 300,
                delayedCounterDelay: 7200,
                confirmationNotificationDelay: 86400,
                confirmationNotificationRepetitions: 0,
                confirmationNotificationRepetitionsInterval: 0,
                confirmationCounterDelay: 7200,
              },
            },
            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('Created resource type id:', result.id)
          }
        } 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 addResourceType() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'booking.v1.resourceType.add',
                params: {
                  fields: {
                    name: 'Equipment Room',
                    code: 'code',
                    isInfoNotificationOn: 'Y',
                    templateTypeInfo: 'inanimate',
                    isConfirmationNotificationOn: 'Y',
                    templateTypeConfirmation: 'animate',
                    isReminderNotificationOn: 'N',
                    templateTypeReminder: 'base',
                    isFeedbackNotificationOn: 'Y',
                    templateTypeFeedback: 'inanimate',
                    isDelayedNotificationOn: 'Y',
                    templateTypeDelayed: 'inanimate',
                    infoNotificationDelay: 300,
                    reminderNotificationDelay: -1,
                    delayedNotificationDelay: 300,
                    delayedCounterDelay: 7200,
                    confirmationNotificationDelay: 86400,
                    confirmationNotificationRepetitions: 0,
                    confirmationNotificationRepetitionsInterval: 0,
                    confirmationCounterDelay: 7200,
                  },
                },
                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('Created resource type id:', result.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addResourceType)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.booking.v1.resource_type.add(
                fields={
                    "name": "Title",
                    "code": "code",
                    "isInfoNotificationOn": "Y",
                    "templateTypeInfo": "inanimate",
                    "isConfirmationNotificationOn": "Y",
                    "templateTypeConfirmation": "animate",
                    "isReminderNotificationOn": "N",
                    "templateTypeReminder": "base",
                    "isFeedbackNotificationOn": "Y",
                    "templateTypeFeedback": "inanimate",
                    "isDelayedNotificationOn": "Y",
                    "templateTypeDelayed": "inanimate",
                    "infoNotificationDelay": 300,
                    "reminderNotificationDelay": -1,
                    "delayedNotificationDelay": 300,
                    "delayedCounterDelay": 7200,
                    "confirmationNotificationDelay": 86400,
                    "confirmationNotificationRepetitions": 0,
                    "confirmationNotificationRepetitionsInterval": 0,
                    "confirmationCounterDelay": 7200,
                },
            ).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(
                    'booking.v1.resourceType.add',
                    [
                        'fields' => [
                            'name'                          => 'Name',
                            'code'                          => 'code',
                            'isInfoNotificationOn'          => 'Y',
                            'templateTypeInfo'              => 'inanimate',
                            'isConfirmationNotificationOn'  => 'Y',
                            'templateTypeConfirmation'      => 'animate',
                            'isReminderNotificationOn'      => 'N',
                            'templateTypeReminder'          => 'base',
                            'isFeedbackNotificationOn'      => 'Y',
                            'templateTypeFeedback'          => 'inanimate',
                            'isDelayedNotificationOn'       => 'Y',
                            'templateTypeDelayed'           => 'inanimate',
                            'infoNotificationDelay'                     => 300,
                            'reminderNotificationDelay'                 => -1,
                            'delayedNotificationDelay'                  => 300,
                            'delayedCounterDelay'           => 7200,
                            'confirmationNotificationDelay'             => 86400,
                            'confirmationNotificationRepetitions'       => 0,
                            'confirmationNotificationRepetitionsInterval' => 0,
                            'confirmationCounterDelay'      => 7200,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding resource type: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "booking.v1.resourceType.add",
            {
                fields: {
                    name: "Name",
                    code: "code",
                    isInfoNotificationOn: "Y",
                    templateTypeInfo: "inanimate",
                    isConfirmationNotificationOn: "Y",
                    templateTypeConfirmation: "animate",
                    isReminderNotificationOn: "N",
                    templateTypeReminder: "base",
                    isFeedbackNotificationOn: "Y",
                    templateTypeFeedback: "inanimate",
                    isDelayedNotificationOn: "Y",
                    templateTypeDelayed: "inanimate",
                    infoNotificationDelay: 300,
                    reminderNotificationDelay: -1,
                    delayedNotificationDelay: 300,
                    delayedCounterDelay: 7200,
                    confirmationNotificationDelay: 86400,
                    confirmationNotificationRepetitions: 0,
                    confirmationNotificationRepetitionsInterval: 0,
                    confirmationCounterDelay: 7200
                }
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'booking.v1.resourceType.add',
            [
                'fields' => [
                    'name' => 'Name',
                    'code' => 'code',
                    'isInfoNotificationOn' => 'Y',
                    'templateTypeInfo' => 'inanimate',
                    'isConfirmationNotificationOn' => 'Y',
                    'templateTypeConfirmation' => 'animate',
                    'isReminderNotificationOn' => 'N',
                    'templateTypeReminder' => 'base',
                    'isFeedbackNotificationOn' => 'Y',
                    'templateTypeFeedback' => 'inanimate',
                    'isDelayedNotificationOn' => 'Y',
                    'templateTypeDelayed' => 'inanimate',
                    'infoNotificationDelay' => 300,
                    'reminderNotificationDelay' => -1,
                    'delayedNotificationDelay' => 300,
                    'delayedCounterDelay' => 7200,
                    'confirmationNotificationDelay' => 86400,
                    'confirmationNotificationRepetitions' => 0,
                    'confirmationNotificationRepetitionsInterval' => 0,
                    'confirmationCounterDelay' => 7200,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "booking.v1.resourceType.add", b24.Params{
        	"fields": b24.Params{
        		"name":                            "Name",
        		"code":                            "code",
        		"isInfoNotificationOn":            "Y",
        		"templateTypeInfo":                "inanimate",
        		"isConfirmationNotificationOn":    "Y",
        		"templateTypeConfirmation":        "animate",
        		"isReminderNotificationOn":        "N",
        		"templateTypeReminder":            "base",
        		"isFeedbackNotificationOn":        "Y",
        		"templateTypeFeedback":            "inanimate",
        		"isDelayedNotificationOn":         "Y",
        		"templateTypeDelayed":             "inanimate",
        		"infoNotificationDelay":                       300,
        		"reminderNotificationDelay":                   -1,
        		"delayedNotificationDelay":                    300,
        		"delayedCounterDelay":             7200,
        		"confirmationNotificationDelay":               86400,
        		"confirmationNotificationRepetitions":         0,
        		"confirmationNotificationRepetitionsInterval": 0,
        		"confirmationCounterDelay":        7200,
        	},
        })
        if err != nil {
        	return fmt.Errorf("booking.v1.resourceType.add: %w", err)
        }
        
        var item struct {
        	ID b24.ID `json:"id"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "id": 17
            },
            "time": {
                "start": 1724068028.331234,
                "finish": 1724068028.726591,
                "duration": 0.3953571319580078,
                "processing": 0.13033390045166016,
                "date_start": "2025-01-21T13:47:08+02:00",
                "date_finish": "2025-01-21T13:47:08+02:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
integer

Identifier of the created resource type

time
time

Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Required fields: code"
        }
        

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

Value

0

Required fields: name, code

Required fields are not provided in fields. The message lists only the missing ones. Code 0 is shared by several errors — tell them apart by the text

100

Could not find value for parameter {fields}

The fields parameter is not provided

422

Invalid value of the {field} field

An invalid value of an enumerated field, for example templateTypeConfirmation

1010

Resource type with code "X" already exists

A resource type with this code already exists

0

Booking tool is disabled. Please contact your administrator.

The Booking tool is disabled in the Bitrix24 settings

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