Docs

Flag a review

Preview· P9
POST
/reviews/{review_id}/flag

Asks a moderator at Agoo to look at a review, against one of the published reasons, with what they should look at. A flag never hides a review: a person decides, in the same queue as everyone's. One open flag per review.

Scope: reviews:write · Plan: Growth, Pro and Enterprise in live mode; every plan in test mode.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs 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:write

Path Parameters

review_id*string

The review's ID.

Match^review_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"review_01m6b3c4d5e6f7g8h9jkmnpqrs"

Header Parameters

Idempotency-Key*string

A 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.

Formatuuid

Request Body

application/json
  1. body
reason*string
Value in"not_genuine""conflict_of_interest""reward_offered""extortion""personal_data""names_me""hate_harassment""threat_violence""security_details""child_safety""advertising_spam""wrong_place""other_unlawful"
note*string

What a moderator should look at.

Length10 <= length <= 2000

Response Body

The flag, waiting for a moderator.

application/json
  1. response
id*string

TypeID with the rreport prefix.

object*"review_flag"
Value in"review_flag"
review_id*ReviewId

A review ID on Agoo Reviews (TypeID with the review prefix).

Match^review_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"review_01m6b3c4d5e6f7g8h9jkmnpqrs"
reason*string
status*string
Value in"open""upheld""dismissed""withdrawn"
created_at*string
Formatdate-time
curl -X POST 'https://api.agoo.ardent.africa/v1/reviews/review_01m6b3c4d5e6f7g8h9jkmnpqrs/flag' \  -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \  -H 'Content-Type: application/json' \  -d '{  "reason": "wrong_place",  "note": "This describes our Tema branch'\''s car park, but it'\''s on the Osu branch'\''s page."}'
{  "id": "string",  "object": "review_flag",  "review_id": "review_01m6b3c4d5e6f7g8h9jkmnpqrs",  "reason": "string",  "status": "open",  "created_at": "2019-08-24T14:15:22Z"}