API Reference

Configure the hosted page

post
https://production-api.shoutaboutus.com/api/v1/custom-landing-page/save

Set the hosted page's options: which sections show, headline, call to action, colours. 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; images you don't upload are kept. Send JSON for settings only, or multipart/form-data with images.

Prerequisites: a bearer token and the account's id (company_id).

Authentication: Partner or Account token. company_id must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise 422.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 5994

The account. Must exist and be inside your account tree.

string

Header logo setting, saved as headerProps.logoURL. Default "" (empty).

string
Defaults to Register Now

Text of the start button. Default Register Now.

string
Defaults to #1459c4

Start button background colour. Default #1459c4.

string
Defaults to #ffffff

Start button text colour. Default #ffffff.

string
Defaults to Contact sales

Text of the contact button. Default Contact sales.

string
Defaults to #ffffff

Contact button background colour. Default #ffffff.

string
Defaults to #1459c4

Contact button text colour. Default #1459c4.

string

Where the contact button links to. Default "" (empty).

string
Defaults to Stop dealing with the headache of responding to your reviews

The main heading. Default Stop dealing with the headache of responding to your reviews.

string
Defaults to Save time, boost your ranking, and build brand loyalty with a personalized review response service that delivers quick and professional replies to your customers.

The 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..

string
Defaults to https://response-scribe.s3.us-east-1.amazonaws.com/assets/sample/ResponseScribe.mp4

The video URL. Default https://response-scribe.s3.us-east-1.amazonaws.com/assets/sample/ResponseScribe.mp4.

boolean
Defaults to false

Hide the video. Default false.

string
Defaults to Trusted by over 10,000 local businesses

Heading of the logo slider. Default Trusted by over 10,000 local businesses.

boolean
Defaults to false

Show the logo slider (the partners gallery images). Default false.

string
Defaults to Choose the plan that fits your needs

Heading of the plans section. Default Choose the plan that fits your needs.

boolean
Defaults to false

Show the plans section. Default false.

boolean
Defaults to false

Show the custom pricing button. Default false.

boolean
Defaults to false

Show the FAQ section (FAQs from Save FAQs). Default false.

string
Defaults to Personalized review response service for local businesses.

Footer text. Default Personalized review response service for local businesses..

string
Defaults to © 2023 Shout About Us. All Rights Reserved

Copyright line. Default © 2023 Shout About Us. All Rights Reserved.

boolean
Defaults to false

Show the social icons in the footer. Default false.

string
Defaults to How it works

Heading of the how-it-works section. Default How it works.

boolean
Defaults to false

Show the how-it-works section (content from Save how-it-works content). Default false.

string
Defaults to You're in good company

Heading of the testimonials section. Default You're in good company.

boolean
Defaults to false

Show the testimonials section (content from Save testimonials). Default false.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?