Make after-sale review links
Makes up to 500 single-use review links for a branch, to give each customer through your own system (a receipt, an order email). Each is valid for 30 days and earns the Invited label. Agoo sends nothing. The links are returned once: Agoo keeps only their hashes.
Scope: reviews:invite · Plan: Growth, Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: reviews:invite
Idempotency-Key*stringA UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the
original response instead of acting twice. While the first request is still running, a retry returns
conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with
rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.
uuidapplication/json- body
place_id*ReviewPlaceIdA branch's ID on Agoo Reviews (TypeID with the rplace prefix): one of your sites, as a page shows it.
^rplace_[0-7][0-9a-hjkmnp-tv-z]{25}$"rplace_01m6a2b3c4d5e6f7g8h9jkmnpq"count*integerHow many links.
1 <= value <= 500The links, shown once.
application/json- response
object*"review_links""review_links"batch_id*stringlinks*array<>expires_at*stringdate-timecurl -X POST 'https://api.agoo.ardent.africa/v1/review-invitations/links' \ -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \ -H 'Content-Type: application/json' \ -d '{ "place_id": "rplace_01m6a2b3c4d5e6f7g8h9jkmnpq", "count": 2}'{ "object": "review_links", "batch_id": "string", "links": [ "http://example.com" ], "expires_at": "2019-08-24T14:15:22Z"}