> ## Documentation Index > Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a Google review > Update an existing Google review. **Access:** an API key with `content:google-reviews:write` (or a master above it: `content:google-reviews:all`, `content:all`, `admin:all`). In published mode (the default) it goes live too, so the key also needs `content:google-reviews:publish` (or a master above it); send `aposMode=draft` (or a draft `_id` and no `aposMode`) to change only the draft. A signed-in person may call it as far as their own permissions allow; anyone else gets 403. **Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with `Retry-After`. ## OpenAPI ````yaml /api-reference/openapi.yaml patch /google-review/{_id} openapi: 3.1.0 info: title: Fetchski Attract CMS API description: >- Auto-generated OpenAPI spec for this Fetchski site instance. Authenticate machine-to-machine requests with an API key by sending the header `Authorization: ApiKey `. Keys are issued in the CMS (API Keys) and carry scopes that limit them to specific actions. Each key also has its own security policy, chosen when it is created: a signing mode (token only, signed writes, or every request signed with the key’s signing secret via `X-Fetchski-Timestamp` + `X-Fetchski-Signature`), an optional network allowlist, and reads/writes-per-minute limits (429 with `Retry-After` over them). Some routes require a signature from every key — see each route. version: 1.0.0 servers: - url: https://{host}/api/v1 description: 'Your site: set `host` to its host name.' variables: host: default: acme.example security: [] tags: - name: Authentication description: >- Sign in as a person to get a bearer token or a session cookie. Integrations use an API key instead: send `Authorization: ApiKey `. - name: SDK Packages description: >- The site’s own npm registry and Composer repository for the Attract SDKs, so an app installs them with one of the site’s API keys. Point npm, pnpm, Bun or Composer at them; the SDKs never call them. - name: Pages description: 'The page tree: each page’s content, place and URL.' - name: Global Content description: Site-wide content and settings every page shares. - name: Redirects description: Old URLs and where they now send visitors. - name: Internationalization description: The site’s locales. - name: Languages description: >- The site’s languages: the main language’s name and every further language’s name, code and Public switch. A save applies at once: a new language gets its home page and its own addresses (/fr/…), and its pages are then translated with each type’s localize routes. - name: Page Templates description: >- The site’s whole-page starting arrangements. They are not pages of the site (the Pages list leaves them out for API keys): read one, then make a page from it with Pages → create and `_copyingId` (`copyingId` in the SDKs). - name: Blog Posts description: The blog’s posts, and importing them from Markdown or MDX. - name: Blog Categories description: The categories posts are filed under. - name: Authors description: The people posts are credited to. - name: Team Members description: The people the Team section shows. - name: Testimonials description: Quotes from customers. - name: FAQ Items description: Questions and their answers. - name: FAQ Categories description: The groups questions are sorted into. - name: Google Reviews description: Reviews from the business’s Google profile, synced on a schedule. - name: Instagram Posts description: Posts from the connected Instagram account, synced on a schedule. - name: Service Areas description: The places the business serves, for the service map. - name: Cookies description: The cookies the consent banner declares. - name: Media description: The Images and Files libraries, and their tags. - name: Videos description: The Videos library. - name: Image Folders description: The folders that organize the Images library. - name: File Folders description: The folders that organize the Files library. - name: Video Folders description: The folders that organize the Videos library. - name: Photo Albums description: Hand-picked, ordered sets of photos for galleries. - name: Photo Feeds description: >- Feeds that collect photos from a connected photo source into the Images library on a schedule. - name: Attachments description: Uploading files and cropping images. - name: Fetchski Media description: >- Read-only discovery over the Images and Videos libraries: find what to reference in an MDX blog import, or which file to use, with its URLs. - name: Forms description: The site’s forms and their fields. - name: Form Submissions description: >- What visitors sent through the site’s forms. Submissions hold personal details: give a key `forms:read` only where it is needed. - name: Conversion Events description: >- The conversion event log — one record per conversion, with its attribution and consent snapshot and its delivery to each ad platform. Read it incrementally, post facts from other systems (a reservation purchase, a lead outcome), and adjust them (refunds, cancellations). One event ID travels everywhere as the platforms’ de-duplication key. - name: Visitor Attribution description: >- Per-visitor attribution on this site: first touch, last ad or campaign touch, and the ad platforms’ browser IDs. The join other systems use to attach a purchase to the marketing-site journey that led to it. - name: Ads Metrics description: >- Aggregates for dashboards: ad-click landings and conversions, by day, platform, campaign and more. - name: Conversions description: >- Conversion definitions — the visitor actions (a lead, a call click, a booking, a purchase) this site reports to the ad platforms, each with a row per platform. Managed by administrators in the CMS. - name: Webhooks description: >- Push notifications of form submissions and conversion-event changes to the site’s Webhook Destinations — signed with each destination’s own secret, retried for a day, at-least-once. Set destinations up in the CMS (Webhook Destinations, for people granted “Manage webhook destinations”): URL, events, optional filters and custom headers, and the signing secret shown once. - name: Request Log description: >- The page views the site captured (Connections → Tracking → Request log), and the query parameters on them: campaign tags and ad click IDs. paths: /google-review/{_id}: patch: tags: - Google Reviews summary: Update a Google review description: >- Update an existing Google review. **Access:** an API key with `content:google-reviews:write` (or a master above it: `content:google-reviews:all`, `content:all`, `admin:all`). In published mode (the default) it goes live too, so the key also needs `content:google-reviews:publish` (or a master above it); send `aposMode=draft` (or a draft `_id` and no `aposMode`) to change only the draft. A signed-in person may call it as far as their own permissions allow; anyone else gets 403. **Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with `Retry-After`. operationId: updateGoogleReview parameters: - name: _id in: path required: true schema: type: string description: >- The document’s `_id`: a full id names its own locale and mode (the draft’s `…:en:draft`, the published one’s `…:en:published`; no `aposMode` needed), a bare `aposDocId` takes the request’s (`aposLocale`, `aposMode`). - $ref: '#/components/parameters/AposMode' - $ref: '#/components/parameters/AposLocale' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleReview' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GoogleReview' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - ApiKeyAuth: - content:google-reviews:write - BearerAuth: [] x-codeSamples: - lang: typescript label: TypeScript source: >- import { createSiteClient } from '@fetchski/attract-cms-sdk'; const site = createSiteClient(); const googleReview = await site.googleReviews().updateGoogleReview({ id: 'clx8m2k4p0000a1b2c3d4e5f6' }); - lang: php label: Laravel source: >- use Fetchski\AttractCmsLaravel\Facades\Attract; $googleReview = Attract::googleReviews()->updateGoogleReview(id: 'clx8m2k4p0000a1b2c3d4e5f6'); components: parameters: AposMode: name: aposMode in: query description: >- `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content::write`), or a signed-in editor. The public and a key with only the read scope get 403. required: false schema: type: string enum: - draft - published default: published example: published AposLocale: name: aposLocale in: query description: >- The locale to read or write, e.g. `en` (default: the site’s default locale). required: false schema: type: string example: fr schemas: GoogleReview: type: object properties: title: type: string title: Title default: '' description: >- Its title: the name it goes by in every list, and the heading of its page where it has one. reviewerName: type: string title: Reviewer name default: '' description: Reviewer name. isAnonymous: type: - boolean - 'null' title: Anonymous reviewer description: >- Set when Google returned no reviewer name. The frontend shows a generic label + initial avatar. default: false rating: type: - integer - 'null' title: Rating (1–5) default: 5 minimum: 1 maximum: 5 x-fetchski-clamped: true description: Rating (1–5). reviewText: type: - string - 'null' title: Review text default: '' description: Review text. reviewedAt: type: - string - 'null' format: date title: Review date description: Review date. featured: type: - boolean - 'null' title: Featured description: >- Hand-curation flag. The widget can be set to show only featured reviews. default: false slug: type: string description: >- The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). title: Slug default: '' x-fetchski-write-optional: Left out, it’s made from the title. visibility: type: - string - 'null' title: Visibility description: Select whether this content is public or private default: public enum: - public - loginRequired - null scheduledPublish: type: - string - 'null' description: An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`. scheduledUnpublish: type: - string - 'null' description: An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`. reviewerPhotoUrl: type: - string - 'null' title: Reviewer photo URL description: >- The reviewer’s Google avatar URL, stored as-is (not downloaded). The frontend renders it directly and falls back to a lettered avatar if missing or stale. When set, a URL; empty or null when not. ownerReply: type: - string - 'null' title: Owner reply description: The business’s public reply to this review, if any. default: '' replyState: type: - string - 'null' title: Reply status at Google description: >- Google moderates owner replies asynchronously: PENDING until reviewed, then APPROVED or REJECTED. Synced from the Business Profile API; blank for manual rows or replies predating moderation visibility. default: '' readOnly: true replyPolicyViolation: type: - string - 'null' title: Reply policy violation description: >- The policy reason Google gave when it rejected the owner reply, if any. default: '' readOnly: true stagedReply: type: - string - 'null' title: Staged reply (not yet pushed) description: >- A reply drafted in the Google Business Dashboard and not yet pushed to Google. Managed by the dashboard’s Review & push flow, never edited here. default: '' readOnly: true stagedReplyAction: type: - string - 'null' title: Staged reply action description: >- What the staged reply will do when pushed: “reply” (create/update the owner reply) or “delete” (remove it). Blank when nothing is staged. default: '' readOnly: true reviewUrl: type: - string - 'null' title: Review link description: >- Permalink to the review on Google, when the provider supplies one. When set, a URL; empty or null when not. source: type: - string - 'null' title: Source default: manual enum: - manual - places-api - business-profile - demo - null description: Source. sourceId: type: - string - 'null' title: Source ID description: >- The review’s stable Google resource id — the de-duplication key set by a sync. Leave blank for manual entries. default: '' gbpLocationId: type: - string - 'null' title: GBP location ID description: >- The Google Business Profile location this review belongs to (bare location id) — set by the Business Profile sync; ties the review to its gbp-location mirror row and the dashboard’s Reviews section. default: '' readOnly: true archived: type: - boolean - 'null' title: Archived default: false description: >- In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document. _id: type: string title: Document ID readOnly: true description: >- The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take. type: type: string title: Document Type readOnly: true description: 'The document type’s name: always this type’s.' createdAt: type: - string - 'null' format: date-time title: Created At readOnly: true description: When it was created (ISO 8601). updatedAt: type: - string - 'null' format: date-time title: Updated At readOnly: true description: When it last changed (ISO 8601). aposShareKey: type: - string - 'null' description: >- The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents. example: k3v9x2m7q1z8w4p6 readOnly: true required: - title - reviewerName - slug - _id - type description: GoogleReview content type ApiError: type: object description: >- An error answer: the error’s name, a message saying what is wrong, and details by error. required: - name properties: name: type: string description: >- The error’s name: `invalid`, `required`, `unauthorized`, `forbidden`, `notfound`, `conflict`, `locked`, `tooManyRequests`, `error` (a server failure)… message: type: string description: What is wrong, and how to fix it. data: type: object additionalProperties: true description: >- Details, by error: `errors` (one entry per field problem, each with its `path`), `retryAfter` (seconds, on 429), `permission`… responses: BadRequest: description: 'The request is not valid: `message` says what to change.' content: application/json: schema: $ref: '#/components/schemas/ApiError' Unauthorized: description: The credential is missing or not accepted. content: application/json: schema: $ref: '#/components/schemas/ApiError' Forbidden: description: The caller may not do this. content: application/json: schema: $ref: '#/components/schemas/ApiError' NotFound: description: Nothing matches, or the caller may not see it. content: application/json: schema: $ref: '#/components/schemas/ApiError' InternalServerError: description: 'The site failed: `message` is the generic “An error occurred.”' content: application/json: schema: $ref: '#/components/schemas/ApiError' securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- Paste your API key as the CMS showed it: `fsk___` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public. BearerAuth: type: http scheme: bearer description: >- A person’s bearer token, from **Signing in (people)** → `POST /@apostrophecms/login/login`. Apps use an API key instead. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.