Skip to main content
Reviews is workspace-scoped and link-based. Add the public review pages a workspace wants to promote. Then invite existing contacts, leads, and inbox participants through the same email, Telnyx SMS, and Meta WhatsApp services already connected to the workspace. Google Business Profile synchronization is not required. A Google review or profile URL works like any other configured destination.

Connected reviews and replies

For workspaces with a connected Google Business Profile account, GET /v1/workspaces/{workspace}/review-locations returns enabled locations. GET /v1/workspaces/{workspace}/reviews lists synchronized reviews with optional location_id, rating, limit (1–100), and cursor filters. Both require engagements:read and return workspace-scoped data. With engagements:manage, use PUT /v1/workspaces/{workspace}/reviews/{review}/reply with {"reply":"Thank you for your feedback."} to publish or replace the provider reply (up to 4,096 characters). DELETE on that path removes the provider reply and returns 204. These operations write to Google and require a connected account; confirm the intended reply before execution and send an Idempotency-Key for retries.

Review destinations

Use GET /workspaces/{workspace}/review-destinations to list the configured Google, Yelp, Facebook, Trustpilot, Tripadvisor, Better Business Bureau, Nextdoor, Foursquare, Houzz, or G2 links. The primary destination is returned first and is the default in the dashboard.

Request a review

Create requests with POST /workspaces/{workspace}/review-requests. Every request requires an existing Contact, a configured destination, a delivery channel, and confirmation that the Contact consented to messages on that channel.
  • email sends a branded invitation to the Contact’s email address.
  • sms sends from the workspace’s configured SMS-capable Telnyx number.
  • whatsapp sends from the workspace’s connected Meta WhatsApp Business account. Supply the UUID of an approved template returned by the channel template endpoints.
SMS copy and WhatsApp template parameters can use {contact}, {business}, and {review_link}. The generated link records the click before redirecting to the selected review site.
Send an Idempotency-Key header when creating a request so a network retry cannot create a second invitation.

Delivery state

GET /workspaces/{workspace}/review-requests returns the latest channel state: queued, sent, delivered, read where supported, clicked, or failed. A click means the Contact opened the tracked link; it does not claim that the destination accepted a review.