canonical: https://jentic.com/apis/goodreviews.com/goodreviews-com # GoodReviews API The GoodReviews API exposes a single endpoint, POST `/api/zapier/campaign/single`, for sending a Google review invitation to one customer at a time. It is designed as the integration surface for Zapier and similar low-code platforms so businesses can fire a review request whenever a job is marked complete in their CRM, POS, or scheduling tool. Authentication is an X-APIKEY header, and the payload identifies the campaign and the customer who should receive the invitation. ## For AI agents Send a Google review invitation to a single customer via the one POST endpoint exposed by the GoodReviews campaign API. ## Scope Does not handle review monitoring, response automation, sentiment analysis, or non-Google review platforms - use for sending a single Google review invitation tied to a configured GoodReviews campaign only. ## Capabilities - Send a single Google review invitation tied to a campaign - Trigger a review request immediately after a job-complete event in a CRM - Pass customer name, email, and phone fields into a configured campaign - Drop a review request into an existing Zapier or Make automation - Use one X-APIKEY token to authenticate every campaign request ## Use cases ### Post-Service Review Request Service businesses fire a Google review invitation the moment a job is marked complete in their CRM. POST `/api/zapier/campaign/single` accepts a campaign ID and the customer's contact details so the right wording is used, and GoodReviews handles the email or SMS delivery and click-through to the Google Business profile. Example prompt: POST `/api/zapier/campaign/single` with campaign id cmp_42 and the customer's name, email, and phone after a job-complete webhook fires. ### Trigger from a POS Event Retailers connect their point-of-sale system to GoodReviews so each transaction over a threshold sends a review invite a few hours later. The single-endpoint design fits low-code platforms perfectly - one Zap or Make scenario maps a POS receipt into a campaign request without custom code. Example prompt: Read a POS webhook for a sale over £50, wait 4 hours, then send a single GoodReviews campaign invitation to the customer's email. ### AI Workflow Step via Jentic An AI agent that already orchestrates customer-facing follow-up can add a review-request step by calling GoodReviews through Jentic. Because the API has only one operation, the agent only needs to load one schema, supply the campaign ID and customer contact, and execute - Jentic handles the X-APIKEY injection. Example prompt: Send a GoodReviews campaign invitation for campaign cmp_loyalty to the customer who just left a 5-star CSAT response. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/api/zapier/campaign/single` | Send a single campaign invitation | ## Key resources - **Campaigns** — Send a single review invitation tied to a configured campaign ## Why Jentic - **Setup:** Wiring GoodReviews by hand means passing the X-APIKEY header against api.goodreviews.com and formatting the single-invitation request body tied to a configured campaign yourself. Through Jentic you install once, import GoodReviews from the API Directory, store the API key once, and your agent calls it. - **Permission scoping:** GoodReviews exposes a single POST `/api/zapier/campaign/single` operation, so the agent's scope is that one operation: sending a Google review invitation tied to a configured campaign. You choose whether the agent may call it, and no other operation is reachable. - **Credential handling:** Your GoodReviews API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'send a google review invitation', and Jentic returns the GoodReviews POST `/api/zapier/campaign/single` operation with its input schema so the agent calls the right endpoint without reading the reference. ## Related APIs - **GoodReviews API (.io)** — Earlier GoodReviews API surface with the same single campaign-invitation endpoint. - **Reply Reviews** — Review request and management platform with broader response and reporting features. - **ClickSend** — Sends the SMS or voice follow-up around a GoodReviews invitation. ## FAQ ### What authentication does the GoodReviews API use? The GoodReviews API uses an X-APIKEY header (apiKey scheme). Through Jentic the key is stored encrypted in the vault and scoped to your GoodReviews account, so the raw key never enters the agent's context. ### Can I send a review invitation with one API call? Yes. POST `/api/zapier/campaign/single` accepts a campaign ID and the customer's name, email, and phone, and GoodReviews handles the email or SMS delivery using the wording configured for that campaign in the GoodReviews dashboard. ### What are the rate limits for the GoodReviews API? GoodReviews applies per-account rate limits sized for typical Zapier traffic. The OpenAPI spec does not encode exact numbers, so check the GoodReviews dashboard or support team before running large bulk imports - for high-volume sends, use a queued automation rather than a tight loop. ### How do I add GoodReviews to an automation through Jentic? Search Jentic for 'send a goodreviews campaign invitation', load the schema for POST `/api/zapier/campaign/single`, and execute with your campaign ID and customer contact. Jentic injects the X-APIKEY at execution so the agent only handles business arguments. ### Does the API support batch invitations in one call? No. The exposed endpoint is `/api/zapier/campaign/single`, which sends one invitation per request. For bulk runs, loop with rate-aware delay or use the GoodReviews dashboard's CSV import. ### Can I limit what my agent is allowed to do with the GoodReviews API? Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, and GoodReviews exposes only a single operation, POST `/api/zapier/campaign/single`, for sending a Google review invitation tied to a configured campaign. You choose whether the agent may call that one operation, and no other action against GoodReviews is reachable. Your GoodReviews API key stays with your own Jentic One instance and is injected only at execution, so the agent sends the invitation without ever seeing the key.