Add a New Resource Type booking.v1.resourceType.add
Scope:
bookingWho 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 |
Description |
|
fields* |
An object containing field values for creating a resource type (detailed description) |
Parameter fields
|
Name |
Description |
|
name* |
The name of the resource type |
|
code* |
A unique code for the resource type |
|
isInfoNotificationOn |
Message to the client about the booking. Possible values:
Default is |
|
templateTypeInfo |
The type of message template for the booking. Possible values:
Default is |
|
isConfirmationNotificationOn |
Automatic confirmation of the booking. Possible values:
Default is |
|
templateTypeConfirmation |
The type of message template for booking confirmation. Possible values:
Default is |
|
isReminderNotificationOn |
Reminder about the booking. Possible values:
Default is |
|
templateTypeReminder |
The type of message template for reminders. Possible values: |
|
isFeedbackNotificationOn |
Request for feedback. Possible values:
Default is |
|
templateTypeFeedback |
The type of message template for feedback requests. Possible values:
Default is |
|
isDelayedNotificationOn |
Reminder when the client is late. Possible values:
Default is |
|
templateTypeDelayed |
The type of message template for delays. Possible values:
Default is |
|
infoDelay |
Delay after which the client receives a booking message. Specified in seconds. Default is 300 |
|
reminderDelay |
Time before the booking when the client receives a reminder. Specified in seconds. Default is -1, in the morning on the day of the booking |
|
delayedDelay |
Time after which to send a message about the delay to the client. Specified in seconds. Default is 300 |
|
delayedCounterDelay |
Time after which to enable the counter in the calendar. Specified in seconds. Default is 7200 |
|
confirmationDelay |
Time before the booking when the client receives the first confirmation message. Specified in seconds. Default is 86400 |
|
confirmationRepetitions |
The number of messages sent to the client for booking confirmation, excluding the first. Default is 0 |
|
confirmationRepetitionsInterval |
Interval between confirmation messages. Specified in seconds. Default is 0 |
|
confirmationCounterDelay |
Time before the booking after which the counter for unconfirmed bookings lights up. Specified in seconds. Default is 7200 |
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","infoDelay":300,"reminderDelay":-1,"delayedDelay":300,"delayedCounterDelay":7200,"confirmationDelay":86400,"confirmationRepetitions":0,"confirmationRepetitionsInterval":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","infoDelay":300,"reminderDelay":-1,"delayedDelay":300,"delayedCounterDelay":7200,"confirmationDelay":86400,"confirmationRepetitions":0,"confirmationRepetitionsInterval":0,"confirmationCounterDelay":7200},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/booking.v1.resourceType.add
try
{
const response = await $b24.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",
infoDelay: 300,
reminderDelay: -1,
delayedDelay: 300,
delayedCounterDelay: 7200,
confirmationDelay: 86400,
confirmationRepetitions: 0,
confirmationRepetitionsInterval: 0,
confirmationCounterDelay: 7200
}
}
);
const result = response.getData().result;
console.dir(result);
}
catch( error )
{
console.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',
'infoDelay' => 300,
'reminderDelay' => -1,
'delayedDelay' => 300,
'delayedCounterDelay' => 7200,
'confirmationDelay' => 86400,
'confirmationRepetitions' => 0,
'confirmationRepetitionsInterval' => 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",
infoDelay: 300,
reminderDelay: -1,
delayedDelay: 300,
delayedCounterDelay: 7200,
confirmationDelay: 86400,
confirmationRepetitions: 0,
confirmationRepetitionsInterval: 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',
'infoDelay' => 300,
'reminderDelay' => -1,
'delayedDelay' => 300,
'delayedCounterDelay' => 7200,
'confirmationDelay' => 86400,
'confirmationRepetitions' => 0,
'confirmationRepetitionsInterval' => 0,
'confirmationCounterDelay' => 7200,
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
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 |
Description |
|
result |
The root element of the response, contains the identifier of the created resource type |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": 0,
"error_description": "Required fields: code"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
|
Required parameter not provided within |
|
|
|
Required parameter not provided |
|
|
|
Invalid field value |
|
|
|
Resource type with this |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Resources: Overview of Methods
- Get Resource Type booking.v1.resourceType.get
- Update Resource Type booking.v1.resourceType.update
- Delete Resource Type booking.v1.resourceType.delete
- Get a list of resource types booking.v1.resourceType.list