Bulk-update credentials across the account

Bulk-sets username + password for one review site across every store under an account, enabling its scraper on each, and optionally persists the credentials so future stores inherit them.

Auth: Both — authentication. account_id must be a bundle_id=3 account-company that passes an ownership check (the auth user's person.company_id must be a parent of it in the company tree). Target stores come, so a Partner can target any account under their tree while an Account user can only target its own account.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
review_site_idintegeryesMust be an existing review site.
usernamestringyes2–1000 chars; NameNoAngleBrackets (no </>). Stored CryptoJS-AES encrypted.
passwordstringyes5–1000 chars; NameNoAngleBrackets. Stored CryptoJS-AES encrypted.
account_idintegeryesAccount-company id (bundle_id=3, not soft-deleted); must belong to caller's hierarchy.
apply_to_future_storesstring (Y/N)noWhen Y, saves the credentials to company_meta_data (category review_site) so future stores reuse them.

Response{ data. } envelope.

  • status (string) — success.
  • message (string) — The username and password has been updated successfully!. Returns a 400 with Store not found! if the account resolves to zero stores or the review site is invalid.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
string
integer
string
Response

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