> For the complete documentation index, see [llms.txt](https://suissu.gitbook.io/su-api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://suissu.gitbook.io/su-api-documentation/su-channel-manager/channel-content-api/booking.com-content-api/facilities/create-update-facility.md).

# Create/Update Facility

This endpoint allows you to **create** or **update** the facilities of a property or a specific room within a property. You can specify the availability and additional details such as parking information, restaurant details, internet connectivity, and more. The request body accepts various facility details, and in case of updates, you can provide an `instance_id` to modify an existing instance.

***

### <mark style="color:yellow;">Endpoint</mark>

<mark style="color:green;background-color:green;">**`POST`**</mark>&#x20;

<div align="left"><figure><img src="https://958347541-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FM9bn2UcBkeqtqixkl5eF%2Fuploads%2FpsybX0n39kUB8Z8WOk4X%2FSandbox%20image.png?alt=media&amp;token=4ae73d0f-0d1a-4d73-a4e2-673dbc081d6a" alt="" width="56"><figcaption></figcaption></figure></div>

{% code overflow="wrap" %}

```url
https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/facilities/set
```

{% endcode %}

***

#### <mark style="color:yellow;">Attributes</mark>

`hotel_id` <mark style="color:orange;">**string (Required)**</mark>

The unique property ID as assigned by the provider upon creation of the property.

***

`channel_hotel_id` <mark style="color:orange;">**string (Required)**</mark>

The unique id for the hotel on the specific channel.

***

`channel_room_id` <mark style="color:orange;">**string (Optional)**</mark>

> **If you are setting up the facility for the particular room then it's required otherwise this field is optional.**

A unique identifier for the room within the specific channel (for example, a property management system or booking platform). This ID allows the system to identify and update the facilities for a particular room in the hotel.

***

`facilities` <mark style="color:orange;">**array (Required)**</mark>

An array of objects, each representing a facility for the property (or individual rooms). The array defines the available facilities and their details such as availability, instances, and configuration.

`facility_id` <mark style="color:orange;">**string (Required)**</mark>

The unique identifier for a facility type (e.g., parking, restaurant, pool, etc.).

`is_available` <mark style="color:orange;">**boolean (Required)**</mark>

Indicates whether this facility is available.

`instances` <mark style="color:orange;">**array (Optional)**</mark>

A list of instances under this facility type. Each instance may have specific configurations.

`instance_id` <mark style="color:orange;">**string (Optional)**</mark>

The unique identifier for a particular instance (used for updates).

{% hint style="info" %}
This is the unique ID for a specific instance of the parking facility that can be updated.
{% endhint %}

***

#### <mark style="color:yellow;">**Parking Facilities**</mark>

`parking_details` <mark style="color:orange;">**object (Required for parking facilities)**</mark>

Details about the parking setup.

`name` <mark style="color:orange;">**string (Optional)**</mark>

The name of the parking lot.

{% hint style="info" %}
For example, "Basement Parking"
{% endhint %}

`parking_location` <mark style="color:orange;">**enum (Optional)**</mark>

The location of the parking facility.&#x20;

{% hint style="info" %}
Possible values are:

* `NEARBY`
* `ON_SITE`
* `UNKNOWN_LOCATION`
  {% endhint %}

`parking_access` <mark style="color:orange;">**enum (Optional)**</mark>

Indicates access restrictions. For example, "ONLY\_GUESTS" means that only hotel guests can use the parking.

`parking_reservation` <mark style="color:orange;">**enum (Optional)**</mark>

Specifies if reservation is needed for parking.&#x20;

{% hint style="info" %}
Possible values are:

* `NOT_NEEDED`
* `REQUIRED`
  {% endhint %}

`payment_details` <mark style="color:orange;">**object (Optional)**</mark>

Defines the payment mode for the parking service.

`charge_mode` <mark style="color:orange;">**enum (Optional)**</mark>

The charge mode for the facility, such as "FREE" or "PAID".

***

#### <mark style="color:yellow;">**Temporarily Closed Facilities**</mark>

`temporarily_closed_details` <mark style="color:orange;">**object (Required for Temporary Closed Facilities)**</mark>

Contains a list of periods when this facility is closed.

`closed` <mark style="color:orange;">**array**</mark>

An array of closed periods.

`start_date` <mark style="color:orange;">**epoch\_seconds**</mark>

The start of the closed period (in Unix timestamp format).

`end_date` <mark style="color:orange;">**epoch\_seconds**</mark>

The end of the closed period (in Unix timestamp format).

***

#### <mark style="color:yellow;">**Other Facility Types**</mark>

indicates that this facility is available.

***

#### <mark style="color:yellow;">**Surcharge Details**</mark>

`surcharge_details` <mark style="color:orange;">**object (Optional)**</mark>

Specifies surcharge details for this facility.

`surcharge_type` <mark style="color:orange;">**string**</mark>

Defines the type of surcharge applied. For example, "DEFAULT" might be the standard surcharge for this facility.

***

#### <mark style="color:yellow;">**Facility Not Available**</mark>

Indicates that this facility is currently **not available**.

***

#### <mark style="color:yellow;">**Scheduled Availability**</mark>

`schedule_details` <mark style="color:orange;">**object**</mark>

Defines the operating schedule for this facility.

`schedule` <mark style="color:orange;">**object**</mark>&#x20;

A list of schedule periods.

`from` <mark style="color:orange;">**object**</mark>

The start time of the schedule period.

`to` <mark style="color:orange;">**object**</mark>

The end time of the schedule period.

`day_of_week` <mark style="color:orange;">**enum**</mark>&#x20;

The day of the week on which this schedule applies.&#x20;

{% hint style="info" %}
For example, `SUNDAY`

Possible values are:

* `MONDAY`
* `TUESDAY`
* `WEDNESDAY`
* `THURSDAY`
* `FRIDAY`
* `SATURDAY`
* `SUNDAY`
  {% endhint %}

***

#### <mark style="color:yellow;">**On-site Details**</mark>

`on_site_details` <mark style="color:orange;">**object**</mark>

Specifies whether the facility is on-site or off-site.

`onsite_type` <mark style="color:orange;">**enum**</mark>

Defines whether the facility is "ON\_SITE" or "OFFSITE".

{% hint style="info" %}
Possible values are:

* `ON_SITE`
* `OFFSITE`
  {% endhint %}

***

#### <mark style="color:yellow;">**Restaurant Details**</mark>

`restaurant_details` <mark style="color:orange;">**object**</mark>

Contains details about the restaurant.

`name` <mark style="color:orange;">**string**</mark>

The name of the restaurant.

`meal_types_list` <mark style="color:orange;">**array**</mark>

A list of meal types provided, such as HALAL or VEGETARIAN.

`cuisines_list` <mark style="color:orange;">**array**</mark>

A list of cuisines offered.

{% hint style="info" %}
For example,  `AUSTRALIAN`, `GERMAN`, `INTERNATIONAL`, etc.
{% endhint %}

***

#### <mark style="color:yellow;">**Swimming Pool Details**</mark>

`swimming_pool_details` <mark style="color:orange;">**object**</mark>

Contains information about the swimming pool.

`name` <mark style="color:orange;">**string**</mark>

The name of the pool.

`swimming_pool_type` <mark style="color:orange;">**enum**</mark>

Defines the type of the swimming pool.

{% hint style="info" %}
Possible values are:

* `INDOOR`
* `OUTDOOR`
* `INDOOR_AND_OUTDOOR`
  {% endhint %}

***

#### <mark style="color:yellow;">**Internet Details**</mark>

`internet_details` <mark style="color:orange;">**object**</mark>

Contains details about internet availability.

`area` <mark style="color:orange;">**enum**</mark>

Specifies the area where internet is available.&#x20;

{% hint style="info" %}
Possible values are:

* `ENTIRE_PROPERTY`
* `ROOM_ONLY`
* `SPECIFIED_AREAS`
  {% endhint %}

`type` <mark style="color:orange;">**enum**</mark>

Specifies the type of internet service.

{% hint style="info" %}
Possible values are:

* `WIFI`
* `LAN`
  {% endhint %}

***

## <mark style="color:yellow;">**Sample Request**</mark>

#### <mark style="color:yellow;">**Request Body to Set Property Facility**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "2",
           "is_available": true,
           "instances": [
               {
                   "instance_id": 95498498,
                   "parking_details": {
                       "name": "Basement Parking",
                       "parking_location": "NEARBY",
                       "parking_access": "ONLY_GUESTS",
                       "parking_reservation": "NOT_NEEDED"
                   },
                   "payment_details": {
                       "charge_mode": "FREE"
                   }
               },
               {
                   "parking_details": {
                       "name": "Basement2 Parking",
                       "parking_location": "ON_SITE",
                       "parking_access": "ONLY_GUESTS",
                       "parking_reservation": "NOT_NEEDED"
                   },
                   "payment_details": {
                       "charge_mode": "FREE"
                   }
               }
           ]
       },
       {
           "facility_id": "7",
           "is_available": true,
           "instances": [
               {
                   "temporarily_closed_details": {
                       "closed": [
                           {
                               "start_date": {
                                   "epoch_seconds": 123648588
                               },
                               "end_date": {
                                   "epoch_seconds": 123648588
                               }
                           },
                           {
                               "start_date": {
                                   "epoch_seconds": 223648588
                               },
                               "end_date": {
                                   "epoch_seconds": 223648588
                               }
                           }
                       ]
                   }
               }
           ]
       },
       {
           "facility_id": "8",
           "is_available": true
       },
       {
           "facility_id": "9",
           "is_available": true,
           "instances": [
               {
                   "surcharge_details": {
                       "surcharge_type": "DEFAULT"
                   }
               }
           ]
       },
       {
           "facility_id": "10",
           "is_available": false
       },
       {
           "facility_id": "11",
           "is_available": true,
           "instances": [
               {
                   "schedule_details": {
                       "schedule": [
                           {
                               "from": {
                                   "hours": 23,
                                   "minutes": 58
                               },
                               "to": {
                                   "hours": 23,
                                   "minutes": 59
                               },
                               "day_of_week": "SUNDAY"
                           }
                       ]
                   }
               }
           ]
       },
       {
           "facility_id": "70",
           "is_available": true,
           "instances": [
               {
                   "on_site_details": {
                       "onsite_type": "OFFSITE"
                   }
               }
           ]
       },
       {
           "facility_id": "3",
           "is_available": true,
           "instances": [
               {
                   "restaurant_details": {
                       "name": "jfjk",
                       "meal_types_list": [
                           "HALAL"
                       ],
                       "cuisines_list": [
                           "AUSTRALIAN",
                           "GERMAN",
                           "RUSSIAN",
                           "LOCAL",
                           "ASIAN",
                           "INTERNATIONAL"
                       ]
                   }
               }
           ]
       },
       {
           "facility_id": "433",
           "is_available": true,
           "instances": [
               {
                   "swimming_pool_details": {
                       "name": "labela",
                       "swimming_pool_type": "INDOOR_AND_OUTDOOR"
                   }
               },
               {
                   "swimming_pool_details": {
                       "name": "updatedlabela",
                       "swimming_pool_type": "INDOOR_AND_OUTDOOR"
                   }
               }
           ]
       },
       {
           "facility_id": "47",
           "is_available": true,
           "instances": [
               {
                   "internet_details": {
                       "area": "ENTIRE_PROPERTY",
                       "type": "WIFI",
                       "wifi_info": {
                           "network_name": "Hathway",
                           "speed_download": "50.25",
                           "speed_upload": "60.25"
                       }
                   }
               }
           ]
       }
   ]
}
```

***

#### <mark style="color:yellow;">Request Body to Set Room Facility</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "channel_room_id": "111111",
   "facilities": [
       {
           "facility_id": "8",
           "is_available": true
       },
       {
           "facility_id": "10",
           "is_available": false
       }
   ]
}
```

***

## <mark style="color:yellow;">**Examples**</mark>

Use the below sample codes to add the provided facilities:

#### <mark style="color:yellow;">**Parking Facilities**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "2",
           "is_available": true,
           "instances": [
               {
                   "instance_id": 95498498,
                   "parking_details": {
                       "name": "Basement Parking",
                       "parking_location": "ON_SITE",
                       "parking_access": "ONLY_GUESTS",
                       "parking_reservation": "NOT_NEEDED"
                   },
                   "payment_details": {
                       "charge_mode": "FREE"
                   }
               }
           ]
       }
   ]
}

```

#### <mark style="color:yellow;">**Attributes**</mark>

`parking_details` <mark style="color:orange;">**object (Required for parking facilities)**</mark>

Details about the parking setup.

`name` <mark style="color:orange;">**string (Optional)**</mark>

The name of the parking lot.

{% hint style="info" %}
For example, "Basement Parking"
{% endhint %}

`parking_location` <mark style="color:orange;">**enum (Optional)**</mark>

The location of the parking facility.&#x20;

{% hint style="info" %}
Possible values are:

* `NEARBY`
* `ON_SITE`
* `UNKNOWN_LOCATION`
  {% endhint %}

`parking_access` <mark style="color:orange;">**enum (Optional)**</mark>

Indicates access restrictions. For example, "ONLY\_GUESTS" means that only hotel guests can use the parking.

`parking_reservation` <mark style="color:orange;">**enum (Optional)**</mark>

Specifies if reservation is needed for parking.&#x20;

{% hint style="info" %}
Possible values are:

* `NOT_NEEDED`
* `REQUIRED`
  {% endhint %}

`payment_details` <mark style="color:orange;">**object (Optional)**</mark>

Defines the payment mode for the parking service.

`charge_mode` <mark style="color:orange;">**enum (Optional)**</mark>

The charge mode for the facility, such as "FREE" or "PAID".

***

#### <mark style="color:yellow;">**Temporarily Closed Facilities**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "7",
           "is_available": true,
           "instances": [
               {
                   "temporarily_closed_details": {
                       "closed": [
                           {
                               "start_date": {
                                   "epoch_seconds": 123648588
                               },
                               "end_date": {
                                   "epoch_seconds": 123648588
                               }
                           }
                       ]
                   }
               }
           ]
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

`temporarily_closed_details` <mark style="color:orange;">**object (Required for Temporary Closed Facilities)**</mark>

Contains a list of periods when this facility is closed.

`closed` <mark style="color:orange;">**array**</mark>

An array of closed periods.

`start_date` <mark style="color:orange;">**epoch\_seconds**</mark>

The start of the closed period (in Unix timestamp format).

`end_date` <mark style="color:orange;">**epoch\_seconds**</mark>

The end of the closed period (in Unix timestamp format).

***

#### <mark style="color:yellow;">**Other Facility Types**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "8",
           "is_available": true
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

indicates that this facility is available.

***

#### <mark style="color:yellow;">**Surcharge Details**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "9",
           "is_available": true,
           "instances": [
               {
                   "surcharge_details": {
                       "surcharge_type": "DEFAULT"
                   }
               }
           ]
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

`surcharge_details` <mark style="color:orange;">**object (Optional)**</mark>

Specifies surcharge details for this facility.

`surcharge_type` <mark style="color:orange;">**string**</mark>

Defines the type of surcharge applied. For example, "DEFAULT" might be the standard surcharge for this facility.

***

#### <mark style="color:yellow;">**Facility Not Available**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "10",
           "is_available": false
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

Indicates that this facility is currently **not available**.

***

#### <mark style="color:yellow;">**Scheduled Availability**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "11",
           "is_available": true,
           "instances": [
               {
                   "schedule_details": {
                       "schedule": [
                           {
                               "from": {
                                   "hours": 23,
                                   "minutes": 58
                               },
                               "to": {
                                   "hours": 23,
                                   "minutes": 59
                               },
                               "day_of_week": "SUNDAY"
                           }
                       ]
                   }
               }
           ]
       }
   ]
}

```

#### <mark style="color:yellow;">**Attributes**</mark>

`schedule_details` <mark style="color:orange;">**object**</mark>

Defines the operating schedule for this facility.

`schedule` <mark style="color:orange;">**object**</mark>&#x20;

A list of schedule periods.

`from` <mark style="color:orange;">**object**</mark>

The start time of the schedule period.

`to` <mark style="color:orange;">**object**</mark>

The end time of the schedule period.

`day_of_week` <mark style="color:orange;">**enum**</mark>&#x20;

The day of the week on which this schedule applies.&#x20;

{% hint style="info" %}
For example, `SUNDAY`

Possible values are:

* `MONDAY`
* `TUESDAY`
* `WEDNESDAY`
* `THURSDAY`
* `FRIDAY`
* `SATURDAY`
* `SUNDAY`
  {% endhint %}

***

#### <mark style="color:yellow;">**On-site Details**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "70",
           "is_available": true,
           "instances": [
               {
                   "on_site_details": {
                       "onsite_type": "OFFSITE"
                   }
               }
           ]
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

`on_site_details` <mark style="color:orange;">**object**</mark>

Specifies whether the facility is on-site or off-site.

`onsite_type` <mark style="color:orange;">**enum**</mark>

Defines whether the facility is "ON\_SITE" or "OFFSITE".

{% hint style="info" %}
Possible values are:

* `ON_SITE`
* `OFFSITE`
  {% endhint %}

***

#### <mark style="color:yellow;">**Restaurant Details**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "3",
           "is_available": true,
           "instances": [
               {
                   "restaurant_details": {
                       "name": "Ocean View Restaurant",
                       "meal_types_list": [
                           "HALAL",
                           "VEGETARIAN"
                       ],
                       "cuisines_list": [
                           "INTERNATIONAL",
                           "ITALIAN",
                           "INDIAN"
                       ]
                   }
               }
           ]
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

`restaurant_details` <mark style="color:orange;">**object**</mark>

Contains details about the restaurant.

`name` <mark style="color:orange;">**string**</mark>

The name of the restaurant.

`meal_types_list` <mark style="color:orange;">**array**</mark>

A list of meal types provided, such as HALAL or VEGETARIAN.

`cuisines_list` <mark style="color:orange;">**array**</mark>

A list of cuisines offered.

{% hint style="info" %}
For example,  `AUSTRALIAN`, `GERMAN`, `INTERNATIONAL`, etc.
{% endhint %}

***

#### <mark style="color:yellow;">**Swimming Pool Details**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "433",
           "is_available": true,
           "instances": [
               {
                   "swimming_pool_details": {
                       "name": "Indoor Outdoor Pool",
                       "swimming_pool_type": "INDOOR_AND_OUTDOOR"
                   }
               }
           ]
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

`swimming_pool_details` <mark style="color:orange;">**object**</mark>

Contains information about the swimming pool.

`name` <mark style="color:orange;">**string**</mark>

The name of the pool.

`swimming_pool_type` <mark style="color:orange;">**enum**</mark>

Defines the type of the swimming pool.

{% hint style="info" %}
Possible values are:

* `INDOOR`
* `OUTDOOR`
* `INDOOR_AND_OUTDOOR`
  {% endhint %}

***

#### <mark style="color:yellow;">**Internet Details**</mark>

```json
{
   "hotel_id": "new1",
   "channel_hotel_id": "12915674",
   "facilities": [
       {
           "facility_id": "47",
           "is_available": true,
           "instances": [
               {
                   "internet_details": {
                       "area": "ENTIRE_PROPERTY",
                       "type": "WIFI",
                       "wifi_info": {
                           "network_name": "Hathway",
                           "speed_download": "50.25",
                           "speed_upload": "60.25"
                       }
                   }
               }
           ]
       }
   ]
}
```

#### <mark style="color:yellow;">**Attributes**</mark>

`internet_details` <mark style="color:orange;">**object**</mark>

Contains details about internet availability.

`area` <mark style="color:orange;">**enum**</mark>

Specifies the area where internet is available.&#x20;

{% hint style="info" %}
Possible values are:

* `ENTIRE_PROPERTY`
* `ROOM_ONLY`
* `SPECIFIED_AREAS`
  {% endhint %}

`type` <mark style="color:orange;">**enum**</mark>

Specifies the type of internet service.

{% hint style="info" %}
Possible values are:

* `WIFI`
* `LAN`
  {% endhint %}

***

## <mark style="color:yellow;">Response</mark>

#### <mark style="color:green;">**Sample Success Response**</mark>

```json
{
   "Status": "Success",
   "Data": [],
   "Message": "Property Facility Set Successfully",
   "Ruid": "3fab8b18-e0b9-4fd8-8235-ccc39a9d33f8"
}
```

#### <mark style="color:yellow;">Success Response Body Elements</mark>

Indicates the result of the API call.&#x20;

{% hint style="info" %}
Will be `"Success"` for successful operations.
{% endhint %}

***

`Data` <mark style="color:orange;">**array**</mark>

An array containing data related to the successful image creation. This typically includes identifiers for the created images.

***

`Message` <mark style="color:orange;">**string**</mark>&#x20;

Provides a brief message about the outcome. Here, it states "Successfully fetch details," confirming that the requested information was retrieved.

***

`Ruid` <mark style="color:orange;">**string**</mark>

A unique identifier for tracking the request.

***

#### <mark style="color:red;">Errors</mark>

<mark style="color:red;">**Sample Error Response 1**</mark>

```json
{
   "Errors": [
       {
           "Code": "400",
           "ShortText": "HotelCode: Invalid HotelCode ('NT711')"
       }
   ],
   "Status": "Fail",
  "Ruid": ""
}
```

<mark style="color:red;">**Sample Error Response 2**</mark>

```json
{
   "Errors": [
       {
           "Code": "573",
           "ShortText": "channel-mapping not found for this property!"
       }
   ],
   "Status": "Fail",
  "Ruid": ""
}
```

<mark style="color:red;">**Sample Error Response 3**</mark>

```json
{
   "Status": "Fail",
   "Errors": [],
   "Message": "Invalid value - [\"instances.parking_details.parking_location\"] - Cannot deserialize value of type `com.booking.accommodation_data.model.facilities.ParkingDetails$Location` from String \"joj\": not one of the values accepted for Enum class: [UNKNOWN_LOCATION, ON_SITE, NEARBY]"
}
```

***

<mark style="color:yellow;">**Error Response Body Elements**</mark>

`Status` <mark style="color:orange;">**string**</mark>

Indicates the result of the API call, which will be always `"Fail"` in case of an error response.

***

`Error` <mark style="color:orange;">**array**</mark>

Array that contains details about any errors that occurred during the API call. Each object in the `Errors` array contains the following properties:

`Code` <mark style="color:orange;">**string**</mark>

Specific error code that helps identify the type of error.

{% hint style="info" %}
For example: `"400"` indicates a bad request.
{% endhint %}

`ShortText` <mark style="color:orange;">**string**</mark>

A short description of the error.

***

`Message` <mark style="color:orange;">**string**</mark>

A message providing more information about the error.

***

`Ruid` <mark style="color:orange;">**string**</mark>

A unique identifier for tracking the request.