Site Object

Field Guide

Name Type Example Notes
id String 52404efc4566740003092640 Unique identifier
status String active Possible values:
  • active
  • inactive
subDomain String helpscout The subdomain part of the Help Scout URL. Example: helpscout.helpscoutdocs.com
cname String docs.helpscout.com The optional host used to access the site.
hasPublicSite Boolean true Indicates if the Site is available to the public.
companyName String Help Scout The name of the associated with the Site.
title String Help Scout Support The title of the Site. Displayed in the top left of the web site if no logo is specified.
logoUrl String http://helpscout.net/logo.png Optional URL that points to a logo to be displayed on the Site.
logoWidth Number 300 The width (in pixels) of the logo image.
logoHeight Number 60 The height (in pixels) of the logo image.
favIconUrl String http://helpscout.net/favicon.png Optional URL that points to a custom favicon.
touchIconUrl String http://helpscout.net/touch-icon.png Optional URL that points to a custom touch icon.
homeUrl String http://helpscout.net The URL to the main web site for the company.
homeLinkText String Home By default the Site's title (or logo if one is specified) will link to the Docs home page. If this attribute is set, the title or logo will link to the main company site (homeUrl) and a link with this text will be added to the navigation bar that points to the Docs home page.
bgColor String #666666 Optional hex value used to set a custom background color.
description String Frequently asked questions and support documentation for Help Scout Optional description that is used in the meta description tag.
hasContactForm Boolean true Indicates if the Site should display a contact form.
mailboxId Number 968 The id of the Help Scout mailbox that should receive messages sent from the contact form.
contactEmail String help@helpscout.net If mailboxId is not specified, messages sent from the contact form will be sent to this email address.
styleSheetUrl String http://helpscout.net/docs-style.css Optional URL used to specify a custom style sheet.
headerCode String   Optional code that will be inserted into the Docs site HTML. Can be used for custom JavaScript, etc.
createdBy Number 29456 The id of the Help Scout user who created the Site.
updatedBy Number 29456 The id of the Help Scout user who last updated the Site.
createdAt DateTime 2013-12-10T15:09:52Z The UTC date and time that the Site was created.
updatedAt DateTime 2013-12-10T15:09:52Z The UTC date and time that the Site was last updated.

Example

{
    "id": 23478,
    "status": "active",
    "subDomain": "helpscout",
    "cname": "docs.helpscout.net",
    "hasPublicSite": true,
    "companyName": "Help Scout",
    "title": "Help Scout Support",
    "logoUrl": "http://helpscout.net/logo.png",
    "logoWidth": 174,
    "logoHeight": 40,
    "favIconUrl": "http://helpscout.net/favicon.png",
    "touchIconUrl": "http://helpscout.net/touchicon.png",
    "homeUrl": "http://helpscout.net",
    "homeLinkText": "Home",
    "bgColor": "#444444",
    "description": "Frequently asked questions and support documentation for Help Scout",
    "hasContactForm": true,
    "mailboxId": 968,
    "contactEmail": null,
    "styleSheetUrl": "http://helpscout.net/docs-style.css",
    "headerCode": null,
    "createdBy": 29456,
    "updatedBy": 29456,
    "createdAt": "2013-12-10T15:09:52Z",
    "updatedAt": "2013-12-10T15:09:52Z"
}
↑Back to top
© Help Scout 2024