Create Site

  • REST Method: POST
  • URL: https://docsapi.helpscout.net/v1/sites
  • Content-Type: application/json

Request

Name Type Required Default Notes
site Site Y   The body of the request (see example below).
reload Boolean N false Set this request parameter to true to return the created Site in the response. 
{
    "status": "active",
    "subDomain": "helpscout",
    "cname": "docs.helpscout.net",
    "hasPublicSite": true,
    "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
}

Accepted Fields

Name Type Required Default Notes
status String N active The status of the Site.
subDomain String Y   The subDomain must be unique across all Help Scout Docs customers. If the subDomain is already in use, a 400 bad request will be returned.
cname String N docs.helpscout.net Use this attribute to specify a CNAME record set up by the Help Scout customer.
hasPublicSite Boolean N true Set this to true to allow public access to the Docs site.
title String Y   Title is displayed on the Site if no logo is present and in the HTML for the Site pages.
logoUrl String N   Optional URL that points to a logo to be displayed on the Site.
logoWidth Number N   If logoUrl is specified, this attribute can be used to indicate the width (in pixels).
logoHeight Number N   If logoUrl is specified, this attribute can be used to indicate the height (in pixels).
favIconUrl String N   Optional URL that points to a custom favicon.
touchIconUrl String N   Optional URL that points to a custom touch icon.
homeUrl String N   The URL to the main web site for the company.
homeLinkText String N  

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.

If homeUrl is not set, this attribute is ignored.
bgColor String N   Optional hex value (i.e. #666666) used to set a custom background color.
description String N   Optional description that is used in the meta description tag.
hasContactForm Boolean N false Indicates if the Site should display a contact form.
mailboxId Number N   The id of the Help Scout mailbox that should receive messages sent from the contact form.
contactEmail String N   If mailboxId is not specified, messages sent from the contact form will be sent to this email address.
styleSheetUrl String N   Optional URL used to specify a custom style sheet.
headerCode String N   Optional code that will be inserted into the Docs site HTML. Can be used for custom JavaScript, etc.

Response

Response Name Type Notes
Header Status Integer 201
Header Location String https://docsapi.helpscout.net/v1/collections/{id} 
Status: 201 Created
Location: https://docsapi.helpscout.net/v1/collections/{id}
↑Back to top
© Help Scout 2024