Turn a landing page URL on or off

Overview

Enable or disable a landing page URL without deleting it.

Use this to stop sending customers to one site for a while, for example if a listing is under review, while keeping the URL saved.

You'll need the location's store_id and the site's review_site_id. To enable a site that has no landing page URL yet, send landing_page_url too; it's saved in the same call.

When disabled, the link is left out of review-request templates. Review collection is unaffected.

Prerequisites

A bearer token. See Authentication.
The location's store_id and the review_site_id.

Base URL

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

Endpoint

POST /api/v1/store-review-site/change-url-status

Authentication

Partner or Account token

store_id must be a location inside your own account tree. A Partner token reaches any location under the partner; an Account token only its own account's locations.
A location outside your tree is rejected with 422. There's no invite-hash option for this endpoint.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Description
`store_id`	integer	Yes	The location. Must exist and be inside your account tree.
`review_site_id`	integer	Yes	The review site. Must exist.
`url_status`	string	Yes	`enable` or `disable`.
`landing_page_url`	string	No	A valid URL. Saved whenever you send it. Required to enable a site that has no landing page URL yet.

Request payload

{
  "store_id": 3007,
  "review_site_id": 1,
  "url_status": "enable",
  "landing_page_url": "https://www.yelp.com/writeareview/biz/demo"
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`message`	string	`URL enabled successfully` or `URL disabled successfully`.

Response payload

{
  "data": {
    "status": "success",
    "message": "URL enabled successfully"
  }
}

Examples

Success payload

Enabled: see Response payload.

Disabled:

{
  "data": {
    "status": "success",
    "message": "URL disabled successfully"
  }
}

Error payload

400 The location doesn't have that review site

{
  "message": "Bad Request",
  "status": "error",
  "errors": {
    "message": "No Record Found!"
  }
}

422 Missing fields

{
  "message": "The review site id field is required. (and 2 more errors)",
  "errors": {
    "review_site_id": [
      "The review site id field is required."
    ],
    "store_id": [
      "The store id field is required."
    ],
    "url_status": [
      "The url status field is required."
    ]
  }
}

422 URL required when enabling

{
  "message": "The landing page URL is required when enabling the URL.",
  "errors": {
    "landing_page_url": [
      "The landing page URL is required when enabling the URL."
    ]
  }
}

422 Location outside your tree

{
  "message": "The selected store id does not belong to your company hierarchy. (and 1 more error)",
  "errors": {
    "store_id": [
      "The selected store id does not belong to your company hierarchy."
    ],
    "url_status": [
      "The selected url status is invalid."
    ]
  }
}

Status	Meaning
`200`	The landing page URL was turned on or off.
`400`	The location doesn't have that review site (`No Record Found!`).
`401`	The token is missing, expired or invalid.
`422`	A field is missing or invalid, enabling without a landing page URL, or the location is outside your tree.
`500`	Unexpected server error.

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/store-review-site/change-url-status" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"store_id": 3007, "review_site_id": 1, "url_status": "enable", "landing_page_url": "https://www.yelp.com/writeareview/biz/demo"}'

Updated 17 days ago

Did this page help you?