Venues

A Venue represents a business location that provides online booking services.

Object definition

Key	Type	Status	Description
id	String	Mandatory	Unique identifier for the Venue.
name	String	Mandatory	Name of the Venue.
externalId	String	Mandatory	Identifier for the Venue in the Partner system.
company[id]	String	Optional	Company ID associated with the Venue. If left blank, a new company is created.
company[name]	String	Optional	Name of the Company associated with the Venue. If left blank, a new company is created.
brand[id]	String	Optional	ID of the Brand associated with the Venue.
brand[name]	String	Optional	Name of the Brand associated with the Venue.
country	String	Mandatory	Country code where the Venue is located (ISO2 format).
address	String	Mandatory	Full address of the Venue.
city	String	Mandatory	City where the Venue is located.
postalCode	String	Mandatory	Postal code where the Venue is located.
phoneNumber	String	Optional	Contact phone number for the Venue.
email	String	Optional	Contact email for the Venue.
emails	Array	Optional	List of email addresses associated with the Venue.
url	String	Optional	Website URL for the Venue.
latitude	String	Optional	Latitude coordinate for the Venue’s location.
longitude	String	Optional	Longitude coordinate for the Venue’s location.
minAdvanceBooking	Int	Optional	Minimum hours in advance required for a booking.
minAdvanceOnlineCancelling	Int	Optional	Minimum hours in advance required to cancel a booking.
minCovers	Int	Optional	Minimum number of covers (seats) allowed per booking.
maxCovers	Int	Optional	Maximum number of covers (seats) allowed per booking.
currency	String	Mandatory	Currency code used for payments (ISO 4217 format).
paymentGateway[gateway]	String	Optional	Payment gateway used `["stripe", "braintree", "adyen"]`.
paymentGateway[publishKey]	String	Optional	Publishable key for the payment gateway.
paymentGateway[merchantId]	String	Optional	Merchant ID for the payment gateway.
timezone	String	Mandatory	Time zone for the Venue’s location (see possible time zone values).
fbInstalled	Boolean	Optional	Indicates if the Facebook Meta Business Extension is installed (`false` for not installed, `true` for installed).
igInstalled	Boolean	Optional	Indicates if the Instagram Meta Business Extension is installed (`false` for not installed, `true` for installed).
fbInstallLink	String	Optional	URL to install the Meta Business Extension for Facebook and Instagram.
bookableAreas	Boolean	Optional	Specifies if the Venue requires selection of an area `[true, false]`.
bookingMessage	String	Optional	Custom message shown to users before placing a reservation. Can be localized per language via Booking Messages.
paymentPolicy	String	Optional	Policy information regarding payments or deposits if a credit card is required. Can be localized per language via Booking Messages as `bookingPolicies`.
confirmationMessage	String	Optional	Custom confirmation message to display after a reservation is completed. Can be localized per language via Booking Messages.
metadata	Object	Optional	Free-form JSON object stored against the Venue, used to carry partner-specific data. Returned as-is in all Venue responses.

Get Available Venues

This endpoint retrieves a list of available Venues.

Endpoint

GET https://api-sandbox.mozrest.com/v1/rms/venues

Query Parameters

Parameter	Status	Description
filters[criteria]	Optional	Filter by Venue name, using `Like %criteria%` format.
filters[city]	Optional	Filter by Venue city, using `Like %city%` format.
filters[brand]	Optional	Filter by Brand ID associated with the Venue.
filters[countryCode]	Optional	Filter by Country code (ISO2 format).
filters[bookingChannel]	Optional	Filter by Booking Channel ID.
filters[notBookingChannel]	Optional	Exclude results with this Booking Channel ID.
filters[fbInstalled]	Optional	Filter Venues with Facebook installed (`0` for not installed, `1` for installed).
filters[igInstalled]	Optional	Filter Venues with Instagram installed (`0` for not installed, `1` for installed).

Example Request:

curl GET "https://api-sandbox.mozrest.com/v1/rms/venues"   
  -H "Authorization: Bearer {{api_key}}"   
  -d "offset=0"   -d "limit=10"   
  -d "filters[criteria]=par"   
  -d "filters[city]=Par"   
  -d "filters[countryCode]=FR"   
  -d "filters[bookingChannel]=60e5a3cab8e5c33agh870101"   
  -d "filters[notBookingChannel]=60e5a3cab8e5c33agh870101"
  -d "filters[fbInstalled]=1"
  -d "filters[igInstalled]=1"

Example Response:

{
  "total": 4,
  "data": [
      {
        "id": "60e5a3ed409541da3650bd90",
        "externalId": "123456789",
        "company": {
          "id": "60e5a3ed409541da3650bd90",
          "name": "Company Name"
        },
        "brand": {
          "id": "60e5a3ed409541da3650bd90",
          "name": "Brand Name"
        },
        "name": "Restaurant Name",
        "countryCode": "GB",
        "address": "The Address 24, Picadilly",
        "city": "London",
        "postalCode": "W1J 9LL",
        "phoneNumber": "442072343456",
        "latitude": null,
        "longitude": null,
        "capacity": 20,
        "url": null,
        "minAdvanceBooking": 1,
        "minAdvanceOnlineCancelling": 24,
        "minCovers": 1,
        "maxCovers": 12,
        "currency": "GBP",
        "paymentGateway": {
          "gateway": "stripe",
          "publishKey": "pk_test_2343823823823",
          "merchantId": null
        },
        "fbInstalled": false,
        "igInstalled": false,
        "fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token&scope=manage_business_extension&extras=%7B%22setup%22%3A%7B%22external_business_id%22%3A%22621e5ba1a5f7c4fbb87ecd9b%22%2C%22timezone%22%3A%22America%5C%2FNew_York%22%2C%22currency%22%3A%22USD%22%2C%22business_vertical%22%3A%22RESERVATIONS%22%7D%2C%22business_config%22%3A%7B%22business%22%3A%7B%22name%22%3A%22Docs+NY%22%7D%2C%22page_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61a45e24757d22026a87f369%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%2C%22below_button_text%22%3A%22In+partnership+with+Mozrest%22%7D%2C%22ig_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61afa0d0b5fb12d27dfa47c4%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%7D%7D%2C%22repeat%22%3Afalse%7D",
        "bookableAreas": "true",
        "bookingMessage": "It is obligatory to wear a mask when you are not seating at the table.",
        "paymentPolicy": "Dinner Cancellation Policy: We ask that any cancellation to your reservation be made no less than 24 hours prior. For no shows, you will be subject to fee of $25 per person that will be applied to the credit card on file.",
        "confirmationMessage": "Thank you for choosing Scampi! We look forward to you dining with us.<b>Please note, there is a 15 minutes grace period for late arrivals and we only seat complete parties.<b> If your party completes later than 15 minutes after your reservation time, you are subject to waiting for the next available table.<br>If we can do anything to better accommodate your dining experience, please email eat@scampinyc.com or call us at 212.888.2171 between 12pm - 5pm, Monday - Friday. <br>",
        "metadata": {
          "region": "eu-west-1"
        }
      }
  ]
}

Get a Specific Venue

This endpoint retrieves details of a specific Venue by its ID.

Endpoint

GET https://api-sandbox.mozrest.com/v1/rms/venues/{id}

Query Parameters

Parameter	Status	Description
id	Mandatory	Venue ID to retrieve. Accepts either the Mozrest ID or the Partner's ID.

Example Request:

curl GET "https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}" \
  -H "Authorization: Bearer {{api_key}}" \

Example Response:

{
  "id": "60e5a3ed409541da3650bd90",
  "externalId": "123456789",
  "company": {
    "id": "60e5a3ed409541da3650bd90",
    "name": "Company Name"
  },
  "brand": {
    "id": "60e5a3ed409541da3650bd90",
    "name": "Brand Name"
  },
  "name": "Restaurant Name",
  "countryCode": "GB",
  "address": "The Address 24, Picadilly",
  "city": "London",
  "postalCode": "W1J 9LL",
  "phoneNumber": "442072343456",
  "latitude": null,
  "longitude": null,
  "capacity": 20,
  "url": null,
  "minAdvanceBooking": 1,
  "minAdvanceOnlineCancelling": 24,
  "minCovers": 1,
  "maxCovers": 12,
  "currency": "GBP",
  "paymentGateway": {
    "gateway": "stripe",
    "publishKey": "pk_test_2343823823823",
    "merchantId": null
  },
  "fbInstalled": false,
  "igInstalled": false,
  "fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token&scope=manage_business_extension&extras=%7B%22setup%22%3A%7B%22external_business_id%22%3A%22621e5ba1a5f7c4fbb87ecd9b%22%2C%22timezone%22%3A%22America%5C%2FNew_York%22%2C%22currency%22%3A%22USD%22%2C%22business_vertical%22%3A%22RESERVATIONS%22%7D%2C%22business_config%22%3A%7B%22business%22%3A%7B%22name%22%3A%22Docs+NY%22%7D%2C%22page_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61a45e24757d22026a87f369%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%2C%22below_button_text%22%3A%22In+partnership+with+Mozrest%22%7D%2C%22ig_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61afa0d0b5fb12d27dfa47c4%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%7D%7D%2C%22repeat%22%3Afalse%7D",
  "bookableAreas": "true",
  "bookingMessage": "It is obligatory to wear a mask when you are not seating at the table.",
  "paymentPolicy": "Dinner Cancellation Policy: We ask that any cancellation to your reservation be made no less than 24 hours prior. For no shows, you will be subject to fee of $25 per person that will be applied to the credit card on file.",
  "confirmationMessage": "Thank you for choosing Scampi! We look forward to you dining with us.<b>Please note, there is a 15 minutes grace period for late arrivals and we only seat complete parties.<b> If your party completes later than 15 minutes after your reservation time, you are subject to waiting for the next available table.<br>If we can do anything to better accommodate your dining experience, please email eat@scampinyc.com or call us at 212.888.2171 between 12pm - 5pm, Monday - Friday. <br>",
  "metadata": {
    "region": "eu-west-1"
  }
}

Get Venue Credentials

This endpoint retrieves the login credentials for a specific Venue to be used during Meta Onboarding.

Endpoint

GET https://api-sandbox.mozrest.com/v1/rms/venues/{id}/credential

Query Parameters

Parameter	Status	Description
id	Mandatory	Venue ID for which to retrieve credentials. Accepts either the Mozrest ID or the Partner's ID.

Example Request:

curl GET "https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}/credential" \
  -H "Authorization: Bearer {{api_key}}" \

Example Response:

{
  "email": "venue@email.com",
  "password": "k9iIB6zPoG6F"
}

Create Venue

This endpoint allows for the creation of a new Venue.

Endpoint

POST https://api-sandbox.mozrest.com/v1/rms/venues

Body Parameters

Parameter	Status	Description
name	Mandatory	Venue name.
externalId	Mandatory	Venue ID in the Partner system.
company	Optional	Company ID to which the venue belongs. If blank, a new company will automatically be generated.
brand	Optional	Brand ID associated with the venue.
country	Mandatory	Country code where the venue is located (ISO2 format).
address	Mandatory	Address where the venue is located.
city	Mandatory	City where the venue is located.
postalCode	Mandatory	Postal code where the venue is located.
phoneNumber	Optional	Venue's phone number.
email	Optional	Venue's email address.
url	Optional	Venue's website URL.
latitude	Optional	Venue's latitude coordinates.
longitude	Optional	Venue's longitude coordinates.
timezone	Mandatory	Time zone of the venue (see possible time zone values).
minAdvanceBooking	Optional	Minimum hours in advance a booking has to be placed.
minAdvanceOnlineCancelling	Optional	Minimum hours in advance a booking can be canceled.
minCovers	Optional	Minimum covers allowed per reservation.
maxCovers	Optional	Maximum covers allowed per reservation.
currency	Mandatory	Currency code used for payments (ISO 4217 format).
paymentGateway[gateway]	Optional	Payment gateway used `[stripe, braintree, adyen]`.
paymentGateway[publishKey]	Optional	Publishable key for the payment gateway.
paymentGateway[merchantId]	Optional	Merchant ID for the payment gateway.
bookableAreas	Optional	Specifies if the venue requires choosing an area for booking `[true, false]`.
bookingMessage	Optional	Message displayed to the user before placing a reservation.
paymentPolicy	Optional	Message regarding payments or deposits if a credit card is required.
confirmationMessage	Optional	Message displayed to the user after placing a reservation.
metadata	Optional	Free-form JSON object to store partner-specific data against the Venue. Returned as-is in Venue responses.

Example Request:

curl POST "https://api-sandbox.mozrest.com/v1/rms/venues" \
  -H "Authorization: Bearer {{api_key}}" \ 
  --data-raw '{
      "name": "Venue Name",
      "externalId": "123456789",
      "company": "60e5a3ed409541da3650bd90",
      "brand": "60e5a3ed409541da3650bd90",
      "country": "GB",
      "address": "The Address 24, Picadilly",
      "city": "London",
      "postalCode": "W1J 9LL",
      "phoneNumber": "442072343456",
      "email": "email@example.com",
      "url": "http://your-url.com",
      "latitude": "51.56797",
      "longitude": "-0.28122",
      "timezone": "Europe/London",
      "capacity": 100,
      "minAdvanceBooking": 1,
      "minAdvanceOnlineCancelling": 24,
      "paymentGateway": {
        "gateway": "stripe",
        "publishKey": "pk_test_2343823823823",
        "merchantId": "123456"
      },
      "currency": "GBP",
      "bookableAreas": "true",
      "bookingMessage": "It is obligatory to wear a mask when you are not seating at the table.",
      "paymentPolicy": "Dinner Cancellation Policy: We ask that any cancellation to your reservation be made no less than 24 hours prior. For no shows, you will be subject to fee of $25 per person that will be applied to the credit card on file.",
      "confirmationMessage": "Thank you for choosing Scampi! We look forward to you dining with us.<b>Please note, there is a 15 minutes grace period for late arrivals and we only seat complete parties.<b> If your party completes later than 15 minutes after your reservation time, you are subject to waiting for the next available table.<br>If we can do anything to better accommodate your dining experience, please email eat@scampinyc.com or call us at 212.888.2171 between 12pm - 5pm, Monday - Friday. <br>",
      "metadata": {
        "region": "eu-west-1"
      }
    }'

Example Response:

{
  "id": "60e5a3ed409541da3650bd90",
  "externalId": "123456789",
  "company": {
    "id": "60e5a3ed409541da3650bd90",
    "name": "Company Name"
  },
  "brand": {
    "id": "60e5a3ed409541da3650bd90",
    "name": "Brand Name"
  },
  "name": "Restaurant Name",
  "countryCode": "GB",
  "address": "The Address 24, Picadilly",
  "city": "London",
  "postalCode": "W1J 9LL",
  "phoneNumber": "442072343456",
  "latitude": null,
  "longitude": null,
  "capacity": 20,
  "url": null,
  "minAdvanceBooking": 1,
  "minAdvanceOnlineCancelling": 24,
  "minCovers": 1,
  "maxCovers": 12,
  "currency": "GBP",
  "paymentGateway": {
    "gateway": "stripe",
    "publishKey": "pk_test_2343823823823",
    "merchantId": null
  },
  "fbInstalled": false,
  "igInstalled": false,
  "fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token&scope=manage_business_extension&extras=%7B%22setup%22%3A%7B%22external_business_id%22%3A%22621e5ba1a5f7c4fbb87ecd9b%22%2C%22timezone%22%3A%22America%5C%2FNew_York%22%2C%22currency%22%3A%22USD%22%2C%22business_vertical%22%3A%22RESERVATIONS%22%7D%2C%22business_config%22%3A%7B%22business%22%3A%7B%22name%22%3A%22Docs+NY%22%7D%2C%22page_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61a45e24757d22026a87f369%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%2C%22below_button_text%22%3A%22In+partnership+with+Mozrest%22%7D%2C%22ig_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61afa0d0b5fb12d27dfa47c4%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%7D%7D%2C%22repeat%22%3Afalse%7D",
  "bookableAreas": "true",
  "bookingMessage": "It is obligatory to wear a mask when you are not seating at the table.",
  "paymentPolicy": "Dinner Cancellation Policy: We ask that any cancellation to your reservation be made no less than 24 hours prior. For no shows, you will be subject to fee of $25 per person that will be applied to the credit card on file.",
  "confirmationMessage": "Thank you for choosing Scampi! We look forward to you dining with us.<b>Please note, there is a 15 minutes grace period for late arrivals and we only seat complete parties.<b> If your party completes later than 15 minutes after your reservation time, you are subject to waiting for the next available table.<br>If we can do anything to better accommodate your dining experience, please email eat@scampinyc.com or call us at 212.888.2171 between 12pm - 5pm, Monday - Friday. <br>",
  "metadata": {
    "region": "eu-west-1"
  }
}

Update Venue

This endpoint allows for updating details of an existing Venue.

Endpoint Request

PUT https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}

Query Parameters

Parameter	Status	Description
venueId	Mandatory	ID of the Venue to update. Accepts either the Mozrest ID or the Partner's ID.

Body Parameters

Parameter	Status	Description
name	Optional	Venue name.
code	Optional	Venue ID in the Partner system (Deprecated; use `externalId`).
country	Optional	Country code (ISO2 format) where the venue is located.
address	Optional	Venue address.
city	Optional	City where the venue is located.
postalCode	Optional	Postal code where the venue is located.
phoneNumber	Optional	Venue's phone number.
email	Optional	Venue's email.
emails	Optional	List of emails associated with the venue.
url	Optional	Venue's website URL.
latitude	Optional	Venue's latitude coordinates.
longitude	Optional	Venue's longitude coordinates.
minAdvanceBooking	Optional	Minimum hours in advance a booking has to be placed.
minAdvanceOnlineCancelling	Optional	Minimum hours in advance a booking can be canceled.
minCovers	Optional	Minimum covers allowed per reservation.
maxCovers	Optional	Maximum covers allowed per reservation.
currency	Optional	Currency code (ISO 4217 format) for payments.
paymentGateway[gateway]	Optional	Payment gateway `[stripe, braintree, adyen]`.
paymentGateway[publishKey]	Optional	Publishable key for the payment gateway.
paymentGateway[merchantId]	Optional	Merchant ID for the payment gateway.
timezone	Optional	Venue's time zone (see possible time zone values).
bookableAreas	Optional	Specifies if the venue requires an area selection for booking `[true, false]`.
bookingMessage	Optional	Message to be displayed before placing a reservation.
paymentPolicy	Optional	Message related to payments/deposits if a credit card is required.
confirmationMessage	Optional	Message displayed to the user after placing a reservation.
metadata	Optional	Free-form JSON object to store partner-specific data against the Venue. Returned as-is in Venue responses.

Example Request:

curl PUT "https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}" \
  -H "Authorization: Bearer {{api_key}}" \ 
--data-raw '{
    "id": "60e5a3ed409541da3650bd90",
    "name": "Restaurant Name",
    "countryCode": "GB",
    "address": "The Address 24, Picadilly",
    "city": "London",
    "postalCode": "W1J 9LL",
    "phoneNumber": "442072343456",
    "latitude": null,
    "longitude": null,
    "capacity": 20,
    "url": null,
    "minAdvanceBooking": 1,
    "minAdvanceOnlineCancelling": 24,
    "minCovers": 1,
    "maxCovers": 12,
    "currency": "GBP",
    "paymentGateway": {
      "gateway": "stripe",
      "publishKey": "pk_test_2343823823823",
      "merchantId": null
    },
    "bookableAreas": "true",
    "bookingMessage": "It is obligatory to wear a mask when you are not seating at the table.",
    "paymentPolicy": "Dinner Cancellation Policy: We ask that any cancellation to your reservation be made no less than 24 hours prior. For no shows, you will be subject to fee of $25 per person that will be applied to the credit card on file.",
    "confirmationMessage": "Thank you for choosing Scampi! We look forward to you dining with us.<b>Please note, there is a 15 minutes grace period for late arrivals and we only seat complete parties.<b> If your party completes later than 15 minutes after your reservation time, you are subject to waiting for the next available table.<br>If we can do anything to better accommodate your dining experience, please email eat@scampinyc.com or call us at 212.888.2171 between 12pm - 5pm, Monday - Friday. <br>",
    "metadata": {
      "region": "eu-west-1"
    }
  }' 

Example Response:

{
  "id": "60e5a3ed409541da3650bd90",
  "externalId": "123456789",
  "company": {
    "id": "60e5a3ed409541da3650bd90",
    "name": "Company Name"
  },
  "brand": {
    "id": "60e5a3ed409541da3650bd90",
    "name": "Brand Name"
  },
  "name": "Restaurant Name",
  "countryCode": "GB",
  "address": "The Address 24, Picadilly",
  "city": "London",
  "postalCode": "W1J 9LL",
  "phoneNumber": "442072343456",
  "latitude": null,
  "longitude": null,
  "capacity": 20,
  "url": null,
  "minAdvanceBooking": 1,
  "minAdvanceOnlineCancelling": 24,
  "minCovers": 1,
  "maxCovers": 12,
  "currency": "GBP",
  "paymentGateway": {
    "gateway": "stripe",
    "publishKey": "pk_test_2343823823823",
    "merchantId": null
  },
  "fbInstalled": false,
  "igInstalled": false,
  "fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token&scope=manage_business_extension&extras=%7B%22setup%22%3A%7B%22external_business_id%22%3A%22621e5ba1a5f7c4fbb87ecd9b%22%2C%22timezone%22%3A%22America%5C%2FNew_York%22%2C%22currency%22%3A%22USD%22%2C%22business_vertical%22%3A%22RESERVATIONS%22%7D%2C%22business_config%22%3A%7B%22business%22%3A%7B%22name%22%3A%22Docs+NY%22%7D%2C%22page_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61a45e24757d22026a87f369%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%2C%22below_button_text%22%3A%22In+partnership+with+Mozrest%22%7D%2C%22ig_cta%22%3A%7B%22enabled%22%3Atrue%2C%22cta_button_text%22%3A%22Reserve%22%2C%22cta_button_url%22%3A%22https%3A%5C%2F%5C%2Fwidget-pre.mozrest.com%3Fkey%3D61afa0d0b5fb12d27dfa47c4%26mzId%3D621e5ba1a5f7c4fbb87ecd9b%26display%3Dvenue%22%7D%7D%2C%22repeat%22%3Afalse%7D",
  "bookableAreas": "true",
  "bookingMessage": "It is obligatory to wear a mask when you are not seating at the table.",
  "paymentPolicy": "Dinner Cancellation Policy: We ask that any cancellation to your reservation be made no less than 24 hours prior. For no shows, you will be subject to fee of $25 per person that will be applied to the credit card on file.",
  "confirmationMessage": "Thank you for choosing Scampi! We look forward to you dining with us.<b>Please note, there is a 15 minutes grace period for late arrivals and we only seat complete parties.<b> If your party completes later than 15 minutes after your reservation time, you are subject to waiting for the next available table.<br>If we can do anything to better accommodate your dining experience, please email eat@scampinyc.com or call us at 212.888.2171 between 12pm - 5pm, Monday - Friday. <br>",
  "metadata": {
    "region": "eu-west-1"
  }
}

Create Venue Booking Messages

The bookingMessage, confirmationMessage and paymentPolicy fields managed through Create Venue and Update Venue hold a single default text. This endpoint lets you store localized versions of those messages per language, so Booking Channels can display them in the guest's language. The localized paymentPolicy is sent and returned as bookingPolicies. When a Booking Channel requests a language, each message is resolved independently: the localized value for that language is returned if it exists; otherwise the Venue's default message is returned (paymentPolicy for bookingPolicies); if neither exists, the field is null.

Booking messages are created once per Venue and language. To modify them afterwards, use Update Venue Booking Messages.

Endpoint

POST https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}/booking-messages

Query Parameters

Parameter	Status	Description
venueId	Mandatory	ID of the Venue. Accepts either the Mozrest ID or the Partner's ID.

Body Parameters

Parameter	Status	Description
locale	Mandatory	Language of the messages (ISO 639-1 format, e.g. `en`, `es`, `fr`). The value is stored as sent and is not validated against a list of languages; Booking Channels must request the exact same value to retrieve the messages (they request `en` when no language is specified).
bookingMessage	Optional	Localized message displayed to the user before placing a reservation.
confirmationMessage	Optional	Localized message displayed to the user after placing a reservation.
bookingPolicies	Optional	Localized version of the Venue's `paymentPolicy`: payment, deposit or cancellation policy displayed to the user when a credit card is required.

At least one of bookingMessage, confirmationMessage or bookingPolicies must be provided with a non-empty value; an empty string is treated as if the field were omitted. Only the fields provided are stored.

On success the endpoint responds 200 OK with the three messages resolved for the given language (localized value, or the Venue's default message when no localized value exists for a field, or null when neither exists).

Error Responses

Status	Code	When
`400 Bad Request`	`ERROR_MESSAGE_VALIDATION_FAILED`	`locale` is missing or empty, or none of `bookingMessage`, `confirmationMessage` or `bookingPolicies` has a non-empty value.
`400 Bad Request`	`ERROR_MESSAGE_RMS_NOT_FOUND`	The Venue is not linked to an RMS integration that supports localized booking messages.
`404 Not Found`	`ERROR_MESSAGE_VENUE_NOT_FOUND`	No Venue found for the given ID.
`409 Conflict`	`ERROR_MESSAGE_VENUE_BOOKING_MESSAGES_ALREADY_EXIST`	A localized `bookingMessage` already exists for this Venue and language. Use Update Venue Booking Messages instead.

Example Request:

curl POST "https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}/booking-messages" \
  -H "Authorization: Bearer {{api_key}}" \
  -H "Content-Type: application/json" \
  --data-raw '{
      "locale": "es",
      "bookingMessage": "Para confirmar tu reserva se requiere una tarjeta de crédito como garantía. No se realizará ningún cargo inmediato.",
      "confirmationMessage": "Gracias por reservar. Recibirás una confirmación de tu reserva por correo electrónico en breve.",
      "bookingPolicies": "Las cancelaciones con menos de 24 horas de antelación tendrán un cargo de 25 € por persona en la tarjeta facilitada."
    }'

Example Response:

{
  "bookingMessage": "Para confirmar tu reserva se requiere una tarjeta de crédito como garantía. No se realizará ningún cargo inmediato.",
  "confirmationMessage": "Gracias por reservar. Recibirás una confirmación de tu reserva por correo electrónico en breve.",
  "bookingPolicies": "Las cancelaciones con menos de 24 horas de antelación tendrán un cargo de 25 € por persona en la tarjeta facilitada."
}

Update Venue Booking Messages

This endpoint updates the localized booking messages of a Venue for a given language. Only the fields provided with a non-empty value are updated; omitted fields (and fields sent as an empty string) keep their current value. A field that was not previously localized for that language is created. It is therefore not possible to clear a stored message through this endpoint.

A localized bookingMessage must already exist for the Venue and language — see Create Venue Booking Messages; otherwise the request fails with a 404 Not Found (ERROR_MESSAGE_VENUE_BOOKING_MESSAGES_NOT_FOUND).

Endpoint

PUT https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}/booking-messages

Query Parameters

Parameter	Status	Description
venueId	Mandatory	ID of the Venue. Accepts either the Mozrest ID or the Partner's ID.

Body Parameters

Parameter	Status	Description
locale	Mandatory	Language of the messages (ISO 639-1 format, e.g. `en`, `es`, `fr`). Must match the value used when the messages were created.
bookingMessage	Optional	Localized message displayed to the user before placing a reservation.
confirmationMessage	Optional	Localized message displayed to the user after placing a reservation.
bookingPolicies	Optional	Localized version of the Venue's `paymentPolicy`: payment, deposit or cancellation policy displayed to the user when a credit card is required.

At least one of bookingMessage, confirmationMessage or bookingPolicies must be provided with a non-empty value; an empty string is treated as if the field were omitted.

Error Responses

Status	Code	When
`400 Bad Request`	`ERROR_MESSAGE_VALIDATION_FAILED`	`locale` is missing or empty, or none of `bookingMessage`, `confirmationMessage` or `bookingPolicies` has a non-empty value.
`400 Bad Request`	`ERROR_MESSAGE_RMS_NOT_FOUND`	The Venue is not linked to an RMS integration that supports localized booking messages.
`404 Not Found`	`ERROR_MESSAGE_VENUE_NOT_FOUND`	No Venue found for the given ID.
`404 Not Found`	`ERROR_MESSAGE_VENUE_BOOKING_MESSAGES_NOT_FOUND`	No localized `bookingMessage` exists yet for this Venue and language. Use Create Venue Booking Messages first.

Example Request:

curl PUT "https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}/booking-messages" \
  -H "Authorization: Bearer {{api_key}}" \
  -H "Content-Type: application/json" \
  --data-raw '{
      "locale": "es",
      "bookingMessage": "Para confirmar tu reserva se requiere una tarjeta de crédito como garantía.",
      "confirmationMessage": "Gracias por reservar. Recibirás una confirmación por correo electrónico y WhatsApp en breve.",
      "bookingPolicies": "Las cancelaciones con menos de 48 horas de antelación tendrán un cargo de 25 € por persona en la tarjeta facilitada."
    }'

Example Response:

{
  "bookingMessage": "Para confirmar tu reserva se requiere una tarjeta de crédito como garantía.",
  "confirmationMessage": "Gracias por reservar. Recibirás una confirmación por correo electrónico y WhatsApp en breve.",
  "bookingPolicies": "Las cancelaciones con menos de 48 horas de antelación tendrán un cargo de 25 € por persona en la tarjeta facilitada."
}

Delete Venue

This endpoint allows for the deletion of a Venue.

Endpoint

DELETE https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}

Query Parameters

Parameter	Status	Description
venueId	Mandatory	ID of the Venue to delete. Accepts either the Mozrest ID or the Partner's ID.

Example Request:

curl DELETE "https://api-sandbox.mozrest.com/v1/rms/venues/{venueId}" \
  -H "Authorization: Bearer {{api_key}}" ' 

Example Response:

{
  removed: true
}

Object definition​

Get Available Venues​

Endpoint​

Query Parameters​

Example Request:​

Example Response:​

Get a Specific Venue​

Endpoint​

Query Parameters​

Example Request:​

Example Response:​

Get Venue Credentials​

Endpoint​

Query Parameters​

Example Request:​

Example Response:​

Create Venue​

Endpoint​

Body Parameters​

Example Request:​

Example Response:​

Update Venue​

Endpoint Request​

Query Parameters​

Body Parameters​

Example Request:​

Example Response:​

Create Venue Booking Messages​

Endpoint​

Query Parameters​

Body Parameters​

Error Responses​

Example Request:​

Example Response:​

Update Venue Booking Messages​

Endpoint​

Query Parameters​

Body Parameters​

Error Responses​

Example Request:​

Example Response:​

Delete Venue​

Endpoint​

Query Parameters​

Example Request:​

Example Response:​

Object definition

Get Available Venues

Endpoint

Query Parameters

Example Request:

Example Response:

Get a Specific Venue

Endpoint

Query Parameters

Example Request:

Example Response:

Get Venue Credentials

Endpoint

Query Parameters

Example Request:

Example Response:

Create Venue

Endpoint

Body Parameters

Example Request:

Example Response:

Update Venue

Endpoint Request

Query Parameters

Body Parameters

Example Request:

Example Response:

Create Venue Booking Messages

Endpoint

Query Parameters

Body Parameters

Error Responses

Example Request:

Example Response:

Update Venue Booking Messages

Endpoint

Query Parameters

Body Parameters

Error Responses

Example Request:

Example Response:

Delete Venue

Endpoint

Query Parameters

Example Request:

Example Response: