Create Settings Asset

  • REST Method: POST
  • URL: https://docsapi.helpscout.net/v1/assets/settings
  • Content-Type: multipart/form-data

Use this endpoint to upload an image used in the global Docs settings. The assetType parameter is used to specify if the image is a logo, favicon or touchicon. Note that the content-type is multipart/form-data. A link to the image will be returned in the response.

Request

Name Type Required Default Notes
key String Y   An API key used to authenticate this request
assetType String Y  
  • logo
  • favicon
  • touchicon

Response

Response Name Type Notes
Header Status Integer 201
{
    "filelink": "https://helpscout.net.s3.amazonaws.com/docs/assets/520459e99af8049acc16b168/images/5238f3533004d407166463c1/photo.jpg",
    "filename": "my-file.jpg",
    "width": 300,
    "height": 100
}