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

封存回覆

封存現有的業主回覆,將其從互動所追蹤的有效回覆中移除。

需要 API 金鑰。標頭格式與金鑰輪替請參閱驗證。

參數

請求主體

名稱類型必填說明
responseIdstring必填ID of the response to archive (the `id` from an interaction's `responses` array).

請求範例

可直接貼上的請求主體。請將預留位置 ID 與值換成您自己的。

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

回應

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

封存先前針對互動發布的回覆。封存會從 Listings API 的本機快取中軟刪除回覆,將其從該互動所追蹤的 responses 中移除,但不會從來源平台撤回該回覆。已在 Google、Yelp 或 Facebook 上發布的回覆仍會在這些平台上公開顯示。

透過 依 ID 取得互動 或 列出互動,從互動的 responses[].id 中取得 responseId。

使用案例:清除已被取代的回覆草稿

如果回覆是誤建的,或在發布前已被取代,請將其封存,讓該互動的 responses 清單保持整潔,並確保您儀表板中的 responded 旗標準確:

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

若要修改已在來源網站上公開顯示的回覆措辭,請改用 編輯回覆,封存不會從發布平台移除該回覆。

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"  }'