Remove a hosted page image

Overview

Remove an image from the hosted page.

Use this to clean up.

You'll need the image reference.

The image is removed, and you get the page's saved settings back. Without imageType nothing is removed and you just get the settings.

Prerequisites

A bearer token. See Authentication.
The account's id (company_id).

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/custom-landing-page/deleteFile

Authentication

Partner or Account token

company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
An account outside your tree, or one that doesn't exist, is rejected with 422.
An account outside your tree, or one that doesn't exist, is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Description
`company_id`	integer	Yes	The account. Must exist and be inside your account tree.
`imageType`	string	No	Which image to remove: `logo` (header logo), `thumbnail` (video thumbnail) or `footerLogo`. Left out: nothing is removed.

Request payload

{
  "company_id": 5994,
  "imageType": "logo"
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`message`	string	`Image deleted successfully.`
`data`	object or array	The page's saved settings after the change, or an empty array `[]` when the page has never been configured.
`data.headerProps`	object	Header settings.
`data.headerProps.logoImage`	string	URL of the header logo, or `""` when there is none.
`data.headerProps.logoURL`	string	Header logo setting, saved as `headerProps.logoURL`.
`data.buttonProps`	object	Button settings.
`data.buttonProps.startButtonText`	string	Text of the start button.
`data.buttonProps.startButtonBackgroundColor`	string	Start button background colour.
`data.buttonProps.startButtonFontColor`	string	Start button text colour.
`data.buttonProps.contactButtonText`	string	Text of the contact button.
`data.buttonProps.contactButtonBackgroundColor`	string	Contact button background colour.
`data.buttonProps.contactButtonFontColor`	string	Contact button text colour.
`data.buttonProps.contactButtonURL`	string	Where the contact button links to.
`data.contentProps`	object	Heading, text and video.
`data.contentProps.youtubeThumbnail`	string	URL of the video thumbnail, or `""` when there is none.
`data.contentProps.contentHeading`	string	The main heading.
`data.contentProps.contentDescription`	string	The text under the heading.
`data.contentProps.youtubeUrl`	string	The video URL.
`data.contentProps.hideVideoToggle`	boolean	Hide the video.
`data.sliderProps`	object	Logo slider.
`data.sliderProps.sliderHeading`	string	Heading of the logo slider.
`data.sliderProps.sliderImagesToggle`	boolean	Show the logo slider (the `partners` gallery images).
`data.planProps`	object	Plans section.
`data.planProps.planText`	string	Heading of the plans section.
`data.planProps.planToggle`	boolean	Show the plans section.
`data.planProps.customPricingButtonToggle`	boolean	Show the custom pricing button.
`data.faqProps`	object	FAQ section.
`data.faqProps.faqToggle`	boolean	Show the FAQ section (FAQs from Save FAQs).
`data.footerProps`	object	Footer.
`data.footerProps.footerLogo`	string	File name of the footer logo, or `""` when there is none.
`data.footerProps.footerText`	string	Footer text.
`data.footerProps.copyrightText`	string	Copyright line.
`data.footerProps.socialIconToggle`	boolean	Show the social icons in the footer.
`data.howItWorksProps`	object	How-it-works section.
`data.howItWorksProps.howItWorksText`	string	Heading of the how-it-works section.
`data.howItWorksProps.howItWorksToggle`	boolean	Show the how-it-works section (content from Save how-it-works content).
`data.testimonialsProps`	object	Testimonials section.
`data.testimonialsProps.testimonialsText`	string	Heading of the testimonials section.
`data.testimonialsProps.testimonialsToggle`	boolean	Show the testimonials section (content from Save testimonials).
`data.referralCode`	string	The account's active referral code, or `""`.

Response payload

{
  "data": {
    "status": "success",
    "message": "Image deleted successfully.",
    "data": {
      "headerProps": {
        "logoURL": "",
        "logoImage": ""
      },
      "buttonProps": {
        "startButtonText": "Register Now",
        "startButtonFontColor": "#ffffff",
        "startButtonBackgroundColor": "#1459c4",
        "contactButtonText": "Contact sales",
        "contactButtonFontColor": "#1459c4",
        "contactButtonBackgroundColor": "#ffffff",
        "contactButtonURL": ""
      },
      "contentProps": {
        "contentHeading": "Stop dealing with the headache of responding to your reviews",
        "contentDescription": "Save time, boost your ranking, and build brand loyalty with a personalized review response service that delivers quick and professional replies to your customers.",
        "youtubeThumbnail": "https://d2ny6zb7otrnhl.cloudfront.net/landing_page_logo/Qm3Xv8Lp2Rt6Yw1Zn4Bc7Df0Gh9Jk5Ls.png",
        "youtubeUrl": "https://response-scribe.s3.us-east-1.amazonaws.com/assets/sample/ResponseScribe.mp4",
        "hideVideoToggle": false
      },
      "sliderProps": {
        "sliderHeading": "Trusted by over 10,000 local businesses",
        "sliderImagesToggle": false
      },
      "planProps": {
        "planText": "Choose the plan that fits your needs",
        "planToggle": false,
        "customPricingButtonToggle": false
      },
      "faqProps": {
        "faqToggle": false
      },
      "footerProps": {
        "footerText": "Personalized review response service for local businesses.",
        "copyrightText": "© 2023 Shout About Us. All Rights Reserved",
        "socialIconToggle": false,
        "footerLogo": "Hn2Kd7Wq4Lp9Xc3Vb6Mz1Ty8Ra5Su0Ge.png"
      },
      "howItWorksProps": {
        "howItWorksText": "How it works",
        "howItWorksToggle": false
      },
      "testimonialsProps": {
        "testimonialsToggle": false,
        "testimonialsText": "You're in good company"
      },
      "referralCode": ""
    }
  }
}

Examples

Success payload

Header logo removed: see Response payload.

The page has never been configured:

{
  "data": {
    "status": "success",
    "message": "Image deleted successfully.",
    "data": []
  }
}

Error payload

422 company_id is missing

{
  "message": "The company id field is required.",
  "errors": {
    "company_id": [
      "The company id field is required."
    ]
  }
}

422 Account outside your tree

{
  "message": "The selected company id does not belong to your company hierarchy.",
  "errors": {
    "company_id": [
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

422 imageType isn't allowed

{
  "message": "The selected image type is invalid.",
  "errors": {
    "imageType": [
      "The selected image type is invalid."
    ]
  }
}

Status	Meaning
`200`	The image was removed; the page's settings.
`401`	The token is missing, expired or invalid.
`422`	`company_id` is missing, doesn't exist or is outside your tree, or `imageType` isn't allowed.
`500`	Unexpected server error, or the image couldn't be removed.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/custom-landing-page/deleteFile" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994, "imageType": "logo"}'