Change URL Status (enable/disable landing page)

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.

Auth: Both — authentication. 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 — Partner any store under its tree, Account only its own account's.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
store_idintegeryesMust be an existing location inside your own account tree.
review_site_idintegeryesMust be an existing review site.
url_statusstring (enable/disable)yesenable needs a landing-page URL (supplied here or already stored); disable never requires one.
landing_page_urlstring (URL)conditionalValidated nullable + url. Required when enabling and no URL is saved on the row yet; saved to the record whenever provided.

Response{ data. } envelope.

  • status (string) — success.
  • 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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
integer
string
string
Responses

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