Add a New Resource booking.v1.resource.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:
bookingWho can execute the method: any user
The method booking.v1.resource.add adds a new resource.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object containing field values for creating a resource (detailed description) |
Parameter fields
|
Name |
Description |
|
name* |
Resource name |
|
description |
Resource description. By default, the field is empty |
|
typeId* |
Resource type identifier. The list of available types can be retrieved using the booking.v1.resourceType.list method |
|
isMain |
How the resource is displayed. Possible values:
Default is |
|
isInfoNotificationOn |
Booking message to the client. Possible values:
Default is |
|
templateTypeInfo |
Message template type for the booking message. Possible values:
Default is |
|
isConfirmationNotificationOn |
Message to the client requesting booking confirmation. Possible values:
Default is |
|
templateTypeConfirmation |
Message template type for booking confirmation. Possible values:
Default is |
|
isReminderNotificationOn |
Booking reminder. Possible values:
Default is |
|
templateTypeReminder |
Message template type for the reminder. The only value is |
|
isFeedbackNotificationOn |
Feedback request. Possible values:
Default is |
|
templateTypeFeedback |
Message template type for the feedback request. Possible values:
Default is |
|
isDelayedNotificationOn |
Reminder when the client is running late. Possible values:
Default is |
|
templateTypeDelayed |
Message template type for late arrival. Possible values:
Default is |
|
isCancellationNotificationOn |
Message to the client after a booking is cancelled. Possible values:
Default is |
|
cancellationNotificationDelay |
Time after a booking is cancelled, after which the client receives the cancellation message. Specified in seconds. Default is 600 |
|
infoNotificationDelay |
Time after which the client receives the booking message. Specified in seconds. Default is 0 |
|
reminderNotificationDelay |
Time before the booking, at which the client receives the reminder. Specified in seconds. The value Default is |
|
delayedNotificationDelay |
Time after which the late arrival message is sent to the client. Specified in seconds. Default is 300 |
|
delayedCounterDelay |
Time after which the counter is activated in the calendar. Specified in seconds. Default is 300 |
|
confirmationNotificationDelay |
Time before the booking, when the client receives the first confirmation message. Specified in seconds. Default is 86400 |
|
confirmationNotificationRepetitions |
Number of confirmation messages sent to the client, excluding the first one. Default is 0 |
|
confirmationNotificationRepetitionsInterval |
Interval between booking confirmation messages. Specified in seconds. Default is 10800 |
|
confirmationCounterDelay |
Time before the booking, after which the unconfirmed booking counter is activated. Specified in seconds. Default is 10800 |
|
senderCode |
Code of the service that sends messages to the client. Possible values:
The method does not validate the value: the codes listed are the ones Bitrix24 supports. Default is |
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.
A resource does not inherit notification configurations from its type: when a resource is created, the fields you did not pass receive the default values from the table above.
Code Examples
How to Use Examples in Documentation
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","infoNotificationDelay":60,"reminderNotificationDelay":-1,"delayedNotificationDelay":300,"delayedCounterDelay":7200,"confirmationNotificationDelay":86400,"confirmationNotificationRepetitions":1,"confirmationNotificationRepetitionsInterval":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","infoNotificationDelay":60,"reminderNotificationDelay":-1,"delayedNotificationDelay":300,"delayedCounterDelay":7200,"confirmationNotificationDelay":86400,"confirmationNotificationRepetitions":1,"confirmationNotificationRepetitionsInterval":3600,"confirmationCounterDelay":7200},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.resource.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
// The method returns the identifier of the created resource as a number, without a wrapper object
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'booking.v1.resource.add',
params: {
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',
infoNotificationDelay: 60,
reminderNotificationDelay: -1,
delayedNotificationDelay: 300,
delayedCounterDelay: 7200,
confirmationNotificationDelay: 86400,
confirmationNotificationRepetitions: 1,
confirmationNotificationRepetitionsInterval: 3600,
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('New resource ID:', result)
}
} 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 addResource() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'booking.v1.resource.add',
params: {
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',
infoNotificationDelay: 60,
reminderNotificationDelay: -1,
delayedNotificationDelay: 300,
delayedCounterDelay: 7200,
confirmationNotificationDelay: 86400,
confirmationNotificationRepetitions: 1,
confirmationNotificationRepetitionsInterval: 3600,
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('New resource ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addResource)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.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",
"infoNotificationDelay": 60,
"reminderNotificationDelay": -1,
"delayedNotificationDelay": 300,
"delayedCounterDelay": 7200,
"confirmationNotificationDelay": 86400,
"confirmationNotificationRepetitions": 1,
"confirmationNotificationRepetitionsInterval": 3600,
"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.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',
'infoNotificationDelay' => 60,
'reminderNotificationDelay' => -1,
'delayedNotificationDelay' => 300,
'delayedCounterDelay' => 7200,
'confirmationNotificationDelay' => 86400,
'confirmationNotificationRepetitions' => 1,
'confirmationNotificationRepetitionsInterval' => 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",
infoNotificationDelay: 60,
reminderNotificationDelay: -1,
delayedNotificationDelay: 300,
delayedCounterDelay: 7200,
confirmationNotificationDelay: 86400,
confirmationNotificationRepetitions: 1,
confirmationNotificationRepetitionsInterval: 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',
'infoNotificationDelay' => 60,
'reminderNotificationDelay' => -1,
'delayedNotificationDelay' => 300,
'delayedCounterDelay' => 7200,
'confirmationNotificationDelay' => 86400,
'confirmationNotificationRepetitions' => 1,
'confirmationNotificationRepetitionsInterval' => 3600,
'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.resource.add", b24.Params{
"fields": b24.Params{
"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",
"infoNotificationDelay": 60,
"reminderNotificationDelay": -1,
"delayedNotificationDelay": 300,
"delayedCounterDelay": 7200,
"confirmationNotificationDelay": 86400,
"confirmationNotificationRepetitions": 1,
"confirmationNotificationRepetitionsInterval": 3600,
"confirmationCounterDelay": 7200,
},
})
if err != nil {
return fmt.Errorf("booking.v1.resource.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": 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 |
Description |
|
result |
Identifier of the created resource |
|
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
The required parameter inside |
|
|
|
The required parameter |
|
|
|
|
|
|
|
The resource could not be saved |
|
|
|
A non-existent |
|
|
|
An invalid value of an enumerated field, for example |
|
|
|
The Booking tool is not available on the current plan |
|
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Resources: Overview of Methods and Events
- Update resource booking.v1.resource.update
- Get resource booking.v1.resource.get
- Get the list of resources booking.v1.resource.list
- Delete Resource booking.v1.resource.delete
- Resource Types: Overview of Methods and Events
- Slots: Overview of Methods
- Event When Creating a Resource onBookingResourceAdd