Docs
API referenceReviews

Remove a catalogue item

Preview· P9
DELETE
/catalogue-items/{item_id}

Takes an item off your page. Reviews that name it keep doing so as they were. item.removed fires. A test key checks it and changes nothing.

Scope: reviews:write · Plan: Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); 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
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: reviews:write

Path Parameters

item_id*string

The item's ID.

Match^ritem_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response Body

The item, removed.

application/json
  1. response

One item in your page's What We Offer on Agoo Reviews: a product, service or programme.

id*string
Match^ritem_[0-7][0-9a-hjkmnp-tv-z]{25}$
object*"catalogue_item"
Value in"catalogue_item"
business_id*string
Match^rbiz_[0-7][0-9a-hjkmnp-tv-z]{25}$
kind*string
Value in"product""service""programme"
name*string
description*string|null
group*|

Your own grouping ("Mains", "Antenatal care").

price*

An item's price as the page shows it, in cedis.

buy_url*|
Formaturi
book_url*|
Formaturi
enquiries*boolean

Readers may send an enquiry about it.

listed*boolean

Shown under What We Offer (false: a review area only).

reviewable*boolean

Reviewers may say a review is about it.

status*string
Value in"live""hidden""removed"
position*integer

Its place in your page's order.

place_ids*array<>

The branches that offer it; empty: every branch.

photos*integer

Published photos (added in the business area).

rating*|

Its rating from the reviews that name it, when there are enough.

url*|
Formaturi
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
test?boolean

A test key's write: checked, not saved.

curl -X DELETE 'https://api.agoohq.com/v1/catalogue-items/string'
{  "id": "string",  "object": "catalogue_item",  "business_id": "string",  "kind": "product",  "name": "string",  "description": "string",  "group": "string",  "price": {    "kind": "fixed",    "min": 0,    "max": 0,    "unit": "string",    "currency": "GHS"  },  "buy_url": "http://example.com",  "book_url": "http://example.com",  "enquiries": true,  "listed": true,  "reviewable": true,  "status": "live",  "position": 0,  "place_ids": [    "rplace_01m6a2b3c4d5e6f7g8h9jkmnpq"  ],  "photos": 0,  "rating": {},  "url": "http://example.com",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "test": true}

Update a catalogue item PATCH

Changes what you send of an item: its words, price, buttons, branches, order, or whether it shows (`live` or `hidden`). `item.updated` fires. A test key checks the change and saves nothing. **Scope:** `reviews:write` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.

List review cases GET

Returns your page's service-recovery cases, newest first: who opened each (your team, the page's rule for 1 and 2 star reviews and serious topics, or the customer), its state, whether it has an owner and is overdue, and the customer's own answer (`sorted`, `not_sorted` or `declined`). Never the team's notes or the conversation. Cases are read here and worked in the Console or the business area. **Scope:** `reviews:read` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.