POST/api/v4/locations/reviews/respond/archive

Eine Antwort archivieren

Archiviert eine vorhandene Inhaberantwort und entfernt sie aus den aktiven Antworten, die für eine Interaktion erfasst werden.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Body

NameTypErforderlichBeschreibung
responseIdstringerforderlichID of the response to archive (the `id` from an interaction's `responses` array).

Beispielanfrage

Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.

Request body
{  "responseId": "2090753a-ece6-4837-8336-8494ad308523"}

Antworten

200Response archived. `data.archiveResponse.status` is `"true"` on success.
Response
{  "data": {    "archiveResponse": {      "status": "true"    }  }}
401Unauthenticated, missing or invalid API key.

Archiviert eine zuvor veröffentlichte Antwort auf eine Interaktion. Die Archivierung ist eine logische Löschung aus dem lokalen Cache der Listings API; sie entfernt die Antwort aus den für die Interaktion erfassten responses, zieht sie aber nicht von der Quellplattform zurück. Bereits auf Google, Yelp oder Facebook veröffentlichte Antworten bleiben dort sichtbar.

Rufen Sie responseId aus responses[].id einer Interaktion über Interaktionen anhand von IDs abrufen oder Interaktionen auflisten ab.

Anwendungsfall: Einen überholten Antwortentwurf entfernen

Wenn eine Antwort versehentlich erstellt oder vor ihrer Veröffentlichung ersetzt wurde, archivieren Sie sie, um die responses-Liste der Interaktion übersichtlich und ihr responded-Flag in Ihrem Dashboard korrekt zu halten:

JSON
{  "responseId": "2090753a-ece6-4837-8336-8494ad308523"}

Um den Wortlaut einer Antwort zu ändern, die bereits auf der Quellwebsite veröffentlicht wurde, verwenden Sie stattdessen Eine Antwort bearbeiten; durch die Archivierung wird sie nicht von der Plattform entfernt.

Request
curl -X POST 'https://listingsapi.com/api/v4/locations/reviews/respond/archive' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "responseId": "2090753a-ece6-4837-8336-8494ad308523"  }'