Configure the hosted page

Overview

Set the hosted page's options: which sections show, headline, call to action, colours.

Use this to set up or change the page.

You'll need the settings.

The page is updated. Each save replaces all the settings: any text you leave out goes back to its default and any toggle you leave out is turned off, so send everything you want to keep. Images you don't upload are kept.

Prerequisites

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

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

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

Choose the content type to match what you are sending:

You are sendingContent type
Settings onlyapplication/json
Any image filemultipart/form-data

Both accept the same fields. Use multipart/form-data whenever you attach an image, because a file can't travel in a JSON body. Each field below is saved under a section of the page settings (see Remove a hosted page image for the saved shape).

FieldTypeRequiredDescription
company_idintegerYesThe account. Must exist and be inside your account tree.
logoImagefile (image)NoHeader logo. PNG or JPEG. Left out: the saved logo is kept.
footerLogofile (image)NoFooter logo. PNG or JPEG. Left out: the saved footer logo is kept.
youtubeThumbnailfile (image)NoVideo thumbnail. PNG or JPEG. Left out: the saved thumbnail is kept.
logoURLstringNoHeader logo setting, saved as headerProps.logoURL. Default "" (empty).
startButtonTextstringNoText of the start button. Default Register Now.
startButtonBackgroundColorstringNoStart button background colour. Default #1459c4.
startButtonFontColorstringNoStart button text colour. Default #ffffff.
contactButtonTextstringNoText of the contact button. Default Contact sales.
contactButtonBackgroundColorstringNoContact button background colour. Default #ffffff.
contactButtonFontColorstringNoContact button text colour. Default #1459c4.
contactButtonURLstringNoWhere the contact button links to. Default "" (empty).
contentHeadingstringNoThe main heading. Default Stop dealing with the headache of responding to your reviews.
contentDescriptionstringNoThe text under the heading. Default Save time, boost your ranking, and build brand loyalty with a personalized review response service that delivers quick and professional replies to your customers..
youtubeUrlstringNoThe video URL. Default https://response-scribe.s3.us-east-1.amazonaws.com/assets/sample/ResponseScribe.mp4.
hideVideoTogglebooleanNoHide the video. Default false.
sliderHeadingstringNoHeading of the logo slider. Default Trusted by over 10,000 local businesses.
sliderImagesTogglebooleanNoShow the logo slider (the partners gallery images). Default false.
planTextstringNoHeading of the plans section. Default Choose the plan that fits your needs.
planTogglebooleanNoShow the plans section. Default false.
customPricingButtonTogglebooleanNoShow the custom pricing button. Default false.
faqTogglebooleanNoShow the FAQ section (FAQs from Save FAQs). Default false.
footerTextstringNoFooter text. Default Personalized review response service for local businesses..
copyrightTextstringNoCopyright line. Default © 2023 Shout About Us. All Rights Reserved.
socialIconTogglebooleanNoShow the social icons in the footer. Default false.
howItWorksTextstringNoHeading of the how-it-works section. Default How it works.
howItWorksTogglebooleanNoShow the how-it-works section (content from Save how-it-works content). Default false.
testimonialsTextstringNoHeading of the testimonials section. Default You're in good company.
testimonialsTogglebooleanNoShow the testimonials section (content from Save testimonials). Default false.

Request payload

JSON, settings only:

{
  "company_id": 5994,
  "startButtonText": "Start now",
  "startButtonBackgroundColor": "#f26b21",
  "startButtonFontColor": "#ffffff",
  "contentHeading": "Stop dealing with the headache of responding to your reviews",
  "faqToggle": true,
  "testimonialsToggle": true
}

With images, send the fields as form parts, plus the files (see Example request).

Response body

The payload is inside data.

FieldTypeDescription
statusstringsuccess.
messagestringSettings save successfully.

Response payload

{
  "data": {
    "status": "success",
    "message": "Settings save successfully."
  }
}

Examples

Success payload

See Response payload.

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 An image isn't PNG or JPEG

{
  "message": "The logo image field must be an image.",
  "errors": {
    "logoImage": [
      "The logo image field must be an image."
    ]
  }
}
StatusMeaning
200The settings were saved.
401The token is missing, expired or invalid.
422company_id is missing, doesn't exist or is outside your tree, or an image isn't a PNG or JPEG.
500Unexpected server error, or an image couldn't be stored.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/custom-landing-page/save" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --form 'company_id=5994' \
  --form '[email protected]' \
  --form '[email protected]' \
  --form '[email protected]' \
  --form 'logoURL=https://www.example.com' \
  --form 'startButtonText=Register Now' \
  --form 'startButtonBackgroundColor=#1459c4' \
  --form 'startButtonFontColor=#ffffff' \
  --form 'contactButtonText=Contact sales' \
  --form 'contactButtonBackgroundColor=#ffffff' \
  --form 'contactButtonFontColor=#1459c4' \
  --form 'contactButtonURL=https://www.example.com/contact' \
  --form 'contentHeading=Stop dealing with the headache of responding to your reviews' \
  --form 'contentDescription=Save time, boost your ranking, and build brand loyalty.' \
  --form 'youtubeUrl=https://example.com/video.mp4' \
  --form 'hideVideoToggle=false' \
  --form 'sliderHeading=Trusted by over 10,000 local businesses' \
  --form 'sliderImagesToggle=false' \
  --form 'planText=Choose the plan that fits your needs' \
  --form 'planToggle=false' \
  --form 'customPricingButtonToggle=false' \
  --form 'faqToggle=false' \
  --form 'footerText=Personalized review response service for local businesses.' \
  --form 'copyrightText=© 2023 Shout About Us. All Rights Reserved' \
  --form 'socialIconToggle=false' \
  --form 'howItWorksToggle=false' \
  --form 'howItWorksText=How it works' \
  --form 'testimonialsToggle=false' \
  --form "testimonialsText=You're in good company"

Did this page help you?