Miniwebsite

The Miniwebsite API is used to access and modify the miniwebsite object on your business' account.

The miniwebsite object acts as the skin that shows around the scheduler on your business' scheduling page.

On this page

1 Miniwebsite API Endpoints
2 Miniwebsite API Parameters
3 Miniwebsite API Request Body/Payloads
4 Miniwebsite API Responses
5 Miniwebsite Object Values

Miniwebsite API Endpoints

These are the endpoints that are available under the /miniwebsite path, which lists all the different miniwebsites you have added to your business account.

Endpoint	Description

Endpoint

Description

GET /miniwebsite

Returns a miniwebsite object for the business.

PUT /miniwebsite

Updates the miniwebsite object on your business' account.

Request body/payload: Must pass a miniwebsite object in the request body/payload.

For these calls, you need to pass a miniwebsite object with all required fields, including the proper businessId property, and any fields you want to update filled in the body of the payload. We have an example of a miniwebsite object in the responses section below.

Miniwebsite API Parameters

Return to top

There are no parameters associated with miniwebsite calls.

Miniwebsite API Request Body/Payloads

Return to top

The objects below represent the minimum viable objects to pass that are needed to update a miniWebsite object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.

{
    "businessId": 43111,
    "businessInfoColor": "#ecf0f1",
    "businessInfoText": "(Text for business info as shown on miniwebsite)",
    "businessInfoVisible": true,
    "createdDate": 1546456949209,
    "createdUser": null,
    "customJs": null,
    "footerBackgroundColor": "#fffff",
    "footerLinkColor": "#e74c3c",
    "footerTextColor": "#34495e",
    "googleAnalyticsCode": null,
    "googleTagManagerCode": null,
    "headerColor": "#ffffff",
    "headerText": "Dog Groomers Anonymous!",
    "iframeHeight": 500,
    "invitationDeclineHeader": null,
    "landingPageStylesJSON": ""{\"body\":{\"backgroundColor\":\"#34495e\",\"color\":\"#1b700c\"},\"businessLogo\":{\"alignment\":\"center\"},\"businessInfo\":{\"backgroundColor\":\"#ecf0f1\"},\"policy\":{\"backgroundColor\":\"#ecf0f1\"},\"schedulerHeaderText\":{\"color\":\"#ffffff\"},\"footerTimeTapLink\":{\"color\":\"#e74c3c\"},\"footer\":{\"color\":\"#34495e\"}}"",
    "landingPageStylesMap": {},
    "logoAlign": "center",
    "logoUrl": null,
    "metaDescription": "Schedule an appointment online!",
    "modifiedDate": 1548183787701,
    "modifiedUser": "JoeSchmo",
    "navigationBackgroundColor": "#ffffff",
    "pageTitle": "Dog Groomers Anonymous",
    "policyBackgroundColor": "#ecf0f1",
    "policyText": "<h4>Policies & Procedures</h4> <p>Cancellations are allowed up to 24 hours before the appointment start time.</p>",
    "policyVisible": false,
    "popupHtml": null,
    "popupJson": null,
    "popupUrl": null,
    "websiteBackgroundColor": "#34495e"
}

Miniwebsite API Responses

Return to Top

{
    "businessId": 43111,
    "businessInfoColor": "#ecf0f1",
    "businessInfoText": "(Text for business info as shown on miniwebsite)",
    "businessInfoVisible": true,
    "createdDate": 1522268786000,
    "createdUser": null,
    "customJs": null,
    "footerBackgroundColor": "#fff",
    "footerLinkColor": "#e74c3c",
    "footerTextColor": "#34495e",
    "googleAnalyticsCode": null,
    "googleTagManagerCode": null,
    "headerColor": "#ffffff",
    "headerText": "Dog Groomers Anonymous",
    "iframeHeight": 500,
    "invitationDeclineHeader": "<p>We're sorry, you've been declined. Buh-bye!</p>",
    "landingPageStylesJson": ""{\"body\":{\"backgroundColor\":\"#34495e\",\"color\":\"#1b700c\"},\"businessLogo\":{\"alignment\":\"center\"},\"businessInfo\":{\"backgroundColor\":\"#ecf0f1\"},\"policy\":{\"backgroundColor\":\"#ecf0f1\"},\"schedulerHeaderText\":{\"color\":\"#ffffff\"},\"footerTimeTapLink\":{\"color\":\"#e74c3c\"},\"footer\":{\"color\":\"#34495e\"}}"
    "logoAlign": "center",
    "logoUrl": null,
    "metaDescription": "Schedule your pooch primping online",
    "modifiedDate": 1681915303731,
    "modifiedUser": "JoeSchmo",
    "navigationBackgroundColor": "#e3dcdc",
    "pageTitle": "Dog Groomers Anonymous",
    "policyBackgroundColor": "#ecf0f1",
    "policyText": "<h4>Policies & Procedures</h4> <p>Cancellations are allowed up to 24 hours before the appointment start time.</p>",
    "policyVisible": false,
    "popupHtml": null,
    "popupJson": null,
    "popupUrl": null,
    "websiteBackgroundColor": "#1aa12e"
}

{
    "businessId": 43111,
    "businessInfoColor": "#ecf0f1",
    "businessInfoText": "(Text for business info as shown on miniwebsite)",
    "businessInfoVisible": true,
    "createdDate": 1522268786000,
    "createdUser": "JoeSchmo",
    "customJs": null,
    "footerBackgroundColor": "#fff",
    "footerLinkColor": "#e74c3c",
    "footerTextColor": "#34495e",
    "googleAnalyticsCode": null,
    "googleTagManagerCode": null,
    "headerColor": "#ffffff",
    "headerText": "Dog Groomers Anonymous",
    "iframeHeight": 500,
    "invitationDeclineHeader": "<p>We're sorry, you've been declined. Buh-bye!</p>",
    "logoAlign": "left",
    "logoUrl": "https://d2ikv6uc9yqmkt.cloudfront.net/business_43111/businesslogo1441501580.jpg",
    "metaDescription": "Schedule your pooch primping online",
    "modifiedDate": null,
    "modifiedUser": null,
    "navigationBackgroundColor": "#e3dcdc",
    "pageTitle": "Dog Groomers Anonymous",
    "policyBackgroundColor": "#ecf0f1",
    "policyText": "<h4>Policies & Procedures</h4> <p>Cancellations are allowed up to 24 hours before the appointment start time.</p>",
    "policyVisible": false,
    "websiteBackgroundColor": "#1aa12e"
}

Miniwebsite Object Values