Miniwebsite

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.

There are no parameters associated with miniwebsite calls.

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"
}

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"
}

Property name	Type	Required	Writable	Description
businessId	integer	Yes		Provides unique numeric ID for business that hosts specified miniwebsite.
businessInfoColor	string		Yes	Displays as a hexadecimal code representing the color used to display business info.
businessInfoText	string		Yes	Displays as text of business info as shown on miniwebsite.
businessInfoVisible	boolean		Yes	Indicates whether or not business info is set as visible.
createdDate	integer			Displays as the date business was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string			Displays the username of the user who created business.
customJs	string		Yes	Displays as what is set as the Custom Javascript call for the miniwebsite.
footerBackgroundColor	string		Yes	Displays as a hexadecimal code representing the color used for the background of miniwebsite footer.
footerLinkColor	string		Yes	Displays as a hexadecimal code representing the color used for the link featured in miniwebsite footer.
footerTextColor	string		Yes	Displays as a hexadecimal code representing the color used for the text in miniwebsite footer.
googleAnalyticsCode	string		Yes	Displays as what is set as the Google Analytics code for the miniwebsite.
headerColor	string		Yes	Displays as a hexadecimal code representing the color used for miniwebsite header.
headerText	string		Yes	Displays as text displayed on the miniwebsite header.
iframeHeight	integer		Yes	Displays as what is set as the Scheduler height of the miniwebsite, in number of pixels.
invitationDeclineHeader	string		Yes	Displays as what is set as the Invitation Campaign Declined Message.
logoAlign	string		Yes	Displays as the direction that logo will be aligned to on the miniwebsite.
logoUrl	string		Yes	Displays as the URL representing the logo featured on the miniwebsite.
metaDescription	string		Yes	Displays as what is set as the SEO / Meta Data fields description for the miniwebsite.
modifiedDate	integer			Displays as date business' miniwebsite was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
modifiedUser	string			Displays the username of user who last modified business' miniwebsite.
navigationBackgroundColor	string		Yes	Displays as a hexadecimal code representing the color used for the background navigation on miniwebsite.
pageTitle	string		Yes	Displays as the text displayed on miniwebsite page title.
policyBackgroundColor	string		Yes	Displays as a hexadecimal code representing the color used for the background of the policy displayed on miniwebsite.
policyText	string		Yes	Displays as the text for the policy displayed on the miniwebsite.
policyVisible	boolean		Yes	Indicates whether or not the policy text is made visible.
websiteBackgroundColor	string		Yes	Displays as a hexadecimal code representing the color used for the background of business' miniwebsite.

Miniwebsite API Endpoints

Miniwebsite API Parameters

Miniwebsite API Parameters

Miniwebsite API Responses

Miniwebsite Object Values