Delete landing page image

Overview

Remove one image (logo, thumbnail or footer logo) from a company's landing_page widget. Deletes the file from S3, clears the corresponding slot in the stored options, and returns the refreshed options blob (with S3 URLs re-resolved).

Prerequisites

A bearer token in the Authorization header.

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

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Account bearer. company_id must sit inside your own account tree.

Rate limit

No rate limit.

Request body

Field	Type	Required	Description
`company_id`	integer	Required	Must be an existing account inside your own account tree.
`imageType`	string	Optional	One of `logo`, `thumbnail`, `footerLogo`; any other value fails validation (422). Omitting it (or sending null) is a no-op.

{
  "company_id": "<brandId>",
  "imageType": "logo"
}

How it works

200 with { status, message, data }; data is the refreshed options blob (or [] when the widget has no options).
422 if company_id is missing/invalid/out of hierarchy, or imageType is not one of the allowed values.
Returns an error envelope (Account not found!) if the company does not exist.

Response

200 OK · `200`

{
  "data": {
    "status": "success",
    "message": "Image deleted successfully.",
    "data": {
      "headerProps": {
        "logoURL": "",
        "logoImage": "https://d2ny6zb7otrnhl.cloudfront.net/landing_page_logo/logo.png"
      },
      "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.",
        "youtubeThumbnail": "",
        "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,
        "sliderImages": null
      },
      "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": null
      },
      "referralCode": "REF123",
      "company": {
        "id": 6
      },
      "faq": [],
      "howItWorksProps": {
        "howItWorksText": "How it works",
        "howItWorksToggle": false,
        "howItWorks": []
      },
      "testimonialsProps": {
        "testimonialsText": "You're in good company",
        "testimonialsToggle": false,
        "testimonials": []
      }
    }
  }
}

422 Validation error · `422`

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

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`422`	Validation error
`500`	Unexpected server error

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": "<brandId>", "imageType": "logo"}'

Updated 8 days ago

Did this page help you?