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




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

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

There are no parameters associated with miniwebsite calls.




Miniwebsite API Parameters

PUT /miniwebsite
{
    "businessId": 43111,
    "businessInfoColor": "#ecf0f1",
    "businessInfoText": "(Text for business info as shown on miniwebsite)",,
    "businessInfoVisible": true,
    "createdDate": 1546456949209,
    "createdUser": null,
    "customJs": null,
    "footerBackgroundColor": "#fff",
    "footerLinkColor": "#e74c3c",
    "footerTextColor": "#34495e",
    "googleAnalyticsCode": null,
    "headerColor": "#ffffff",
    "headerText": "Dog Groomers Anonymous!",
    "iframeHeight": 500,
    "invitationDeclineHeader": null,
    "landingPageStylesJSON": null,
    "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

GET /miniwebsite
{
    "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,
    "headerColor": "#ffffff",
    "headerText": "Dog Groomers Anonymous",
    "iframeHeight": 500,
    "invitationDeclineHeader": "<p>We're sorry, you've been declined. Buh-bye!</p>",
    "logoAlign": "left",
    "logoUrl": null,
    "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"
}
PUT /miniwebsite
{
    "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": "UA-13",
    "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

Property nameTypeRequiredWritableDescription
businessId
integerYes
Provides unique numeric ID for business that hosts specified miniwebsite.
businessInfoColorstring
YesDisplays as a hexadecimal code representing the color used to display business info.
businessInfoTextstring
YesDisplays as text of business info as shown on miniwebsite.
businessInfoVisibleboolean
Yes Indicates whether or not business info is set as visible.
createdDateinteger

Displays as the date business was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUserstring

Displays the username of the user who created business.
customJsstring
YesDisplays as what is set as the Custom Javascript call for the miniwebsite.
footerBackgroundColorstring
YesDisplays as a hexadecimal code representing the color used for the background of miniwebsite footer.
footerLinkColorstring
YesDisplays as a hexadecimal code representing the color used for the link featured in miniwebsite footer.
footerTextColorstring
YesDisplays as a hexadecimal code representing the color used for the text in miniwebsite footer.
googleAnalyticsCodestring
YesDisplays as what is set as the Google Analytics code for the miniwebsite.
headerColorstring
YesDisplays as a hexadecimal code representing the color used for miniwebsite header.
headerTextstring
YesDisplays as text displayed on the miniwebsite header.
iframeHeightinteger
YesDisplays as what is set as the Scheduler height of the miniwebsite, in number of pixels.
invitationDeclineHeaderstring
YesDisplays as what is set as the Invitation Campaign Declined Message.
logoAlignstring
YesDisplays as the direction that logo will be aligned to on the miniwebsite.
logoUrlstring
YesDisplays as the URL representing the logo featured on the miniwebsite.
metaDescriptionstring
YesDisplays as what is set as the SEO / Meta Data fields description for the miniwebsite.
modifiedDateinteger

Displays as date business' miniwebsite was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
modifiedUserstring

Displays the username of user who last modified business' miniwebsite.
navigationBackgroundColorstring
YesDisplays as a hexadecimal code representing the color used for the background navigation on miniwebsite.
pageTitlestring
YesDisplays as the text displayed on miniwebsite page title.
policyBackgroundColorstring
YesDisplays as a hexadecimal code representing the color used for the background of the policy displayed on miniwebsite. 
policyTextstring
YesDisplays as the text for the policy displayed on the miniwebsite.
policyVisibleboolean
YesIndicates whether or not the policy text is made visible.
websiteBackgroundColorstring
YesDisplays as a hexadecimal code representing the color used for the background of business' miniwebsite.