Change URL Status (enable/disable landing page)

Overview

Toggle url_status (enable/disable) of a store's landing-page URL — drives the "Enable URL" column on the Landing Page grid. A landing_page_url may be supplied in the same request and is saved to the record; enabling requires a landing-page URL (sent here or already stored). Disabling never requires a URL.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

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

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• Authenticated-only (no public hash flow). The guard resolves the api guard explicitly.

• store_id must pass an ownership check, so it must be in the auth user's hierarchy.

• A Partner reaches any store under its tree. An Account reaches only its own account's.

Rate limit

• No rate limit.

Request body

• Body:

{
  "store_id": 10,
  "review_site_id": 5,
  "url_status": "enable",
  "landing_page_url": "https://example.com/landing"
}

Response

• data.status (string) — success.
• data.message (string) — URL enabled successfully / URL disabled successfully.

Errors

• 422 — a required field is missing, url_status not in enable/disable, enabling without any URL (supplied or stored), or landing_page_url is not a valid URL.
• 400 — no matching (store, review-site) row (No Record Found!).
• 401 — missing/invalid token.
• 500 — unexpected server error.

200 OK - URL enabled · 200

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

200 OK - URL disabled · 200

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

422 Unprocessable Entity - URL required when enabling · 422

{
  "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."
    ]
  }
}

400 Bad Request - record not found · 400

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

401 Unauthorized - missing/invalid token · 401

{
  "message": "Unauthenticated."
}

Errors

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": 10, "review_site_id": 5, "url_status": "enable", "landing_page_url": "https://example.com/landing"}'