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.

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.

PUT /miniwebsite

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

GET /miniwebsite

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

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

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

Miniwebsite

Miniwebsite API Endpoints

Miniwebsite API Parameters

Miniwebsite API Request Body/Payloads

Miniwebsite API Responses

Miniwebsite Object Values