Brands
A Brand represents a group of Venues within a Company.
While it’s an optional resource, it becomes especially valuable when managing a Company with multiple Brands. This is particularly useful for integration with Meta Booking Channels (Facebook and Instagram), as it enables each Brand to install a “Reserve” button on their respective Facebook page or Instagram profile. By using this feature, customers can access a Booking Widget that includes a Venue selector, streamlining the booking process for multi-venue Brands.
Object definition
| Key | Type | Mandatory | Description |
|---|---|---|---|
| id | String | Yes | Brand id. |
| name | String | Yes | Brand's name. |
| company | Array | Yes | Company to which the Brand belongs. |
| company[id] | String | Yes | Company's id. |
| company[name] | String | Yes | Company's name. |
| logo | String | No | Brand's logo. |
| fbInstalled | Bool | No | If the Facebook widget is installed at company level. |
| igInstalled | Bool | No | If the Instagram widget is installed at company level. |
| fbInstallLink | String | Yes | URL ready to install the Meta Business Extension for Facebook and Instagram. |
Get Available Brands
This endpoint retrieves a list of Brands.
Endpoint
GET https://api-sandbox.mozrest.com/v1/rms/brands
Example Request:
curl --location 'https://api-sandbox.mozrest.com/v1/rms/brands' --header 'Authorization: Bearer ebda68797d69a4780fa73c33e7418e71646e614ade27aa3bd0fc45315b74c1babf481771de1f7bda'Example Response:
{
"total": 2,
"data": [
{
"id": "619f9c3de5f97823ea767gs4",
"name": "Delicatessen",
"company": {
"id": "619dd442ca4b1064fcd99b08",
"name": "Mozrest Sandbox"
},
"logo": null,
"fbInstalled": false,
"igInstalled": false,
"fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp-pre.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token..."
}
]
}Get a Specific Brand
This endpoint retrieves a specific Brand.
Endpoint
GET https://api-sandbox.mozrest.com/v1/rms/brands/{brandId}
Query Parameters
| Parameter | Status | Description |
|---|---|---|
| brandId | Mandatory | Id of the Brand to retrieve. |
Example Request:
curl --location 'https://api-sandbox.mozrest.com/v1/rms/brands/{brandId}' --header 'Authorization: Bearer ebda68797d69a4780fa73c33e7418e71646e614ade27aa3bd0fc45315b74c1babf481771de1f7bda'Example Response:
{
"id": "619f9c3de5f97823ea767gs4",
"name": "Delicatessen",
"company": {
"id": "619dd442ca4b1064fcd99b08",
"name": "Mozrest Sandbox"
},
"logo": null,
"fbInstalled": false,
"igInstalled": false,
"fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp-pre.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token..."
}Create a Brand
This endpoint allows you to create a Brand.
Endpoint
POST https://api-sandbox.mozrest.com/v1/rms/brands
Body Parameters
| Parameter | Status | Description |
|---|---|---|
| name | Mandatory | Brand's name. |
| company | Mandatory | Company to which the Brand belongs. |
| logo | Optional | Brand's logo. |
Example Request:
curl --location 'https://api-sandbox.mozrest.com/v1/rms/brands' --header 'Authorization: Bearer ebda68797d69a4780fa73c33e7418e71646e614ade27aa3bd0fc45315b74c1babf481771de1f7bda' --header 'Content-Type: application/json' --data '{
"name": "Delicatessen",
"company": "619dd442ca4b1064fcd99b08",
"logo": "https://my-logo-url.com"
}'Example Response:
{
"id": "6401acd07e03aba11dc6ec71",
"name": "Delicatessen",
"company": {
"id": "619dd442ca4b1064fcd99b08",
"name": "Mozrest Sandbox"
},
"logo": "https://my-logo-url.com",
"fbInstalled": null,
"igInstalled": null,
"fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp-pre.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token..."
}Update Brand
This endpoint allows you to update a Brand.
Endpoint
PUT https://api-sandbox.mozrest.com/v1/rms/brands/{brandId}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
| brandId | Mandatory | Id of the Brand to update. |
Body Parameters
| Parameter | Status | Description |
|---|---|---|
| name | Mandatory | Brand's name. |
| logo | Optional | Brand's logo. |
Example Request:
curl --location --request PUT 'https://api-sandbox.mozrest.com/v1/rms/brands/{brandId}' --header 'Authorization: Bearer ebda68797d69a4780fa73c33e7418e71646e614ade27aa3bd0fc45315b74c1babf481771de1f7bda' --header 'Content-Type: application/json' --data '{
"name": "Delicatessen",
"logo": "https://my-logo-url.com"
}'Example Response:
{
"id": "6401acd07e03aba11dc6ec71",
"name": "Delicatessen",
"company": {
"id": "619dd442ca4b1064fcd99b08",
"name": "Mozrest Sandbox"
},
"logo": "https://my-logo-url.com",
"fbInstalled": null,
"igInstalled": null,
"fbInstallLink": "https://facebook.com/dialog/oauth?client_id=1181690592254979&display=page&redirect_uri=https%3A%2F%2Fapp-pre.mozrest.com%2Fauth%2Ffacebook%2Fcallback&response_type=token..."
}