Update a single store-review-site row's URL, landing page, credentials and site-specific extras (BBB / Caring / SeniorAdvisor fields), enables its scraper when a URL is present on an active store, and dispatches a pull job.
Auth: Both — authentication OR invite hash. Authenticated callers target the row via store_review_site_id, or via store_id+review_site_id, or client_location_id+review_site_id (the alt identifiers resolves to a pivot id in prepareForValidation, scoped to the caller's accessible stores), then an ownership check enforces hierarchy. The hash flow accepts ONLY store_review_site_id and binds it to the hash's store. Per role: Partner can reach/resolve rows across its whole tree, Account only its account's. The endpoint scopes client_location_id resolution per caller so the same id can differ between partners.
Rate limit: 30 requests/min.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
store_review_site_id | integer | one identifier path required | Direct pivot id (highest priority); exists + an ownership check. |
store_id | integer | with review_site_id (alt path) | Must be an existing location; resolves the pivot within the store. |
client_location_id | string | with review_site_id (alt path) | Max 255; resolves within caller's accessible stores. |
review_site_id | integer | required when using store_id or client_location_id | Must be an existing review site. |
hash | string | hash flow only | Invite hashid [store_id,15]; tokenless; only with store_review_site_id. |
url | string (url) | optional | 5–2000 chars. |
landing_page_url | string (url) | optional | 5–2000; defaults to url when you omit it. |
username | string | optional | 2–1000; NameNoAngleBrackets. |
password | string | optional | 5–1000; becomes required_with:username when the row has no saved creds and the site is not non-LDE. |
bbb_owner_name / bbb_owner_email / bbb_location_zip | string | sometimes-required (BBB, id 45) | |
sa_replier_first_name / _last_name / _email / _title | string | sometimes-required (SeniorAdvisor, id 68) | |
external_id / external_name | string | required_if:review_site_id,20 (Caring) | Max 255; setting external_id connects Caring. |
conFirmDisableTwoFactorAuthentication | integer (0/1) | optional | 1 resets the row out of the 2FA-pending state. |
Response — { data. } envelope.
status(string) —success.message(string) —The URL and/or password was successfully updated!.
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||