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