Add a New Resource booking.v1.resource.add

Scope: booking

Who can execute the method: any user

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

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	An object containing field values for creating a resource (detailed description)

Parameter fields

Name `type`	Description
name* `string`	The name of the resource
description `string`	The description of the resource. By default, an empty string
typeId* `integer`	The identifier of the resource type. A list of available types can be obtained using the method booking.v1.resourceType.list
isMain `string`	How to display the resource. Possible values: `Y` — in the schedule columns `N` — when resources overlap By default, `Y`
isInfoNotificationOn `string`	Message to the client about the booking. Possible values: `Y` — enabled `N` — disabled By default, `Y`
templateTypeInfo `string`	The type of the booking notification message template. Possible values: `inanimate` — template for booking equipment and rooms `animate` — template for booking specialists By default, `inanimate`
isConfirmationNotificationOn `string`	Automatic confirmation of the booking. Possible values: `Y` — enabled `N` — disabled By default, `Y`
templateTypeConfirmation `string`	The type of the confirmation message template. Possible values: `inanimate` — template for booking equipment and rooms `animate` — template for booking specialists By default, `inanimate`
isReminderNotificationOn `string`	Reminder about the booking. Possible values: `Y` — enabled `N` — disabled By default, `Y`
templateTypeReminder `string`	The type of the reminder message template. Possible values: `base`
isFeedbackNotificationOn `string`	Feedback request. Possible values: `Y` — enabled `N` — disabled By default, `Y`
templateTypeFeedback `string`	The type of the feedback request message template. Possible values: `inanimate` — template for booking equipment and rooms `animate` — template for booking specialists By default, `inanimate`
isDelayedNotificationOn `string`	Reminder when the client is late. Possible values: `Y` — enabled `N` — disabled By default, `Y`
templateTypeDelayed `string`	The type of the delay message template. Possible values: `inanimate` — template for booking equipment and rooms `animate` — template for booking specialists By default, `inanimate`
infoDelay `integer`	The delay after which the client receives a booking message. Specified in seconds. By default, 300
reminderDelay `integer`	The time before the booking when the client receives a reminder. Specified in seconds. By default, -1, in the morning on the day of the booking
delayedDelay `integer`	The time after which to send the client a message about being late. Specified in seconds. By default, 300
delayedCounterDelay `integer`	The time after which to enable the counter in the calendar. Specified in seconds. By default, 7200
confirmationDelay `integer`	The time before the booking when the client receives the first confirmation message. Specified in seconds. By default, 86400
confirmationRepetitions `integer`	The number of messages sent to the client for booking confirmation, excluding the first. By default, 0
confirmationRepetitionsInterval `integer`	The interval between confirmation messages. Specified in seconds. By default, 0
confirmationCounterDelay `integer`	The time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds. By default, 7200

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Name","description":"Description","typeId":1,"isMain":"N","isInfoNotificationOn":"Y","templateTypeInfo":"inanimate","isConfirmationNotificationOn":"Y","templateTypeConfirmation":"animate","isReminderNotificationOn":"N","templateTypeReminder":"base","isFeedbackNotificationOn":"Y","templateTypeFeedback":"inanimate","isDelayedNotificationOn":"Y","templateTypeDelayed":"inanimate","infoDelay":60,"reminderDelay":-1,"delayedDelay":300,"delayedCounterDelay":7200,"confirmationDelay":86400,"confirmationRepetitions":1,"confirmationRepetitionsInterval":3600,"confirmationCounterDelay":7200}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/booking.v1.resource.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Name","description":"Description","typeId":1,"isMain":"N","isInfoNotificationOn":"Y","templateTypeInfo":"inanimate","isConfirmationNotificationOn":"Y","templateTypeConfirmation":"animate","isReminderNotificationOn":"N","templateTypeReminder":"base","isFeedbackNotificationOn":"Y","templateTypeFeedback":"inanimate","isDelayedNotificationOn":"Y","templateTypeDelayed":"inanimate","infoDelay":60,"reminderDelay":-1,"delayedDelay":300,"delayedCounterDelay":7200,"confirmationDelay":86400,"confirmationRepetitions":1,"confirmationRepetitionsInterval":3600,"confirmationCounterDelay":7200},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/booking.v1.resource.add

try
        {
        	const response = await $b24.callMethod(
        		'booking.v1.resource.add',
        		{
        			fields: {
        				name: 'Name',
        				description: 'Description',
        				typeId: 1,
        				isMain: 'N',
        				isInfoNotificationOn: 'Y',
        				templateTypeInfo: 'inanimate',
        				isConfirmationNotificationOn: 'Y',
        				templateTypeConfirmation: 'animate',
        				isReminderNotificationOn: 'N',
        				templateTypeReminder: 'base',
        				isFeedbackNotificationOn: 'Y',
        				templateTypeFeedback: 'inanimate',
        				isDelayedNotificationOn: 'Y',
        				templateTypeDelayed: 'inanimate',
        				infoDelay: 60,
        				reminderDelay: -1,
        				delayedDelay: 300,
        				delayedCounterDelay: 7200,
        				confirmationDelay: 86400,
        				confirmationRepetitions: 1,
        				confirmationRepetitionsInterval: 3600,
        				confirmationCounterDelay: 7200
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if (result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch( error )
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'booking.v1.resource.add',
                    [
                        'fields' => [
                            'name' => 'Name',
                            'description' => 'Description',
                            'typeId' => 1,
                            'isMain' => 'N',
                            'isInfoNotificationOn' => 'Y',
                            'templateTypeInfo' => 'inanimate',
                            'isConfirmationNotificationOn' => 'Y',
                            'templateTypeConfirmation' => 'animate',
                            'isReminderNotificationOn' => 'N',
                            'templateTypeReminder' => 'base',
                            'isFeedbackNotificationOn' => 'Y',
                            'templateTypeFeedback' => 'inanimate',
                            'isDelayedNotificationOn' => 'Y',
                            'templateTypeDelayed' => 'inanimate',
                            'infoDelay' => 60,
                            'reminderDelay' => -1,
                            'delayedDelay' => 300,
                            'delayedCounterDelay' => 7200,
                            'confirmationDelay' => 86400,
                            'confirmationRepetitions' => 1,
                            'confirmationRepetitionsInterval' => 3600,
                            '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: ' . $e->getMessage();
        }

BX24.callMethod(
            "booking.v1.resource.add",
            {
                fields: {
                    name: "Name",
                    description: "Description",
                    typeId: 1,
                    isMain: "N",
                    isInfoNotificationOn: "Y",
                    templateTypeInfo: "inanimate",
                    isConfirmationNotificationOn: "Y",
                    templateTypeConfirmation: "animate",
                    isReminderNotificationOn: "N",
                    templateTypeReminder: "base",
                    isFeedbackNotificationOn: "Y",
                    templateTypeFeedback: "inanimate",
                    isDelayedNotificationOn: "Y",
                    templateTypeDelayed: "inanimate",
                    infoDelay: 60,
                    reminderDelay: -1,
                    delayedDelay: 300,
                    delayedCounterDelay: 7200,
                    confirmationDelay: 86400,
                    confirmationRepetitions: 1,
                    confirmationRepetitionsInterval: 3600,
                    confirmationCounterDelay: 7200
                }
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'booking.v1.resource.add',
            [
                'fields' => [
                    'name' => 'Name',
                    'description' => 'Description',
                    'typeId' => 1,
                    'isMain' => 'N',
                    'isInfoNotificationOn' => 'Y',
                    'templateTypeInfo' => 'inanimate',
                    'isConfirmationNotificationOn' => 'Y',
                    'templateTypeConfirmation' => 'animate',
                    'isReminderNotificationOn' => 'N',
                    'templateTypeReminder' => 'base',
                    'isFeedbackNotificationOn' => 'Y',
                    'templateTypeFeedback' => 'inanimate',
                    'isDelayedNotificationOn' => 'Y',
                    'templateTypeDelayed' => 'inanimate',
                    'infoDelay' => 60,
                    'reminderDelay' => -1,
                    'delayedDelay' => 300,
                    'delayedCounterDelay' => 7200,
                    'confirmationDelay' => 86400,
                    'confirmationRepetitions' => 1,
                    'confirmationRepetitionsInterval' => 3600,
                    'confirmationCounterDelay' => 7200
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "id": 1823
            },
            "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 `object`	The root element of the response, contains the identifier of the created resource
time `time`	Information about the execution time of the request

Error Handling

HTTP Status: 400

{
            "error": 1013,
            "error_description": "Resource type with id 17 does not exist"
        }

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
`0`	`Required fields: name`	The required parameter inside `fields` is missing
`100`	`Could not find value for parameter {fields}`	The required parameter `fields` is missing
`1006`	`ResourceType not found`	`typeId` is not specified
`1013`	`Resource type with id does not exist`	A non-existent `typeId` is specified
`422`	`Invalid value of the field`	Invalid field value

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

Overview of methods

Update resource

Add a New Resource booking.v1.resource.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning