POST/api/v4/locations/reviews/respond/edit

インタラクションへの返信を編集する

レビューまたはインタラクションに以前投稿したオーナーの返信を編集します。

API キーが必要です。ヘッダーの形式とキーのローテーションについては認証を参照してください。

パラメーター

ボディ

名前型必須説明
responseIdstring必須ID of the response to edit (the `id` from an interaction's `responses` array).
reviewIdstring必須ID of the interaction the response belongs to.
responseContentstring必須Updated text content of the response.
templateIdstring任意Response-template ID to re-attribute the edited reply to, if any.

リクエストの例

そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。

Request body
{  "reviewId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",  "responseId": "2090753a-ece6-4837-8336-8494ad308523",  "responseContent": "Thank you again: we've updated our reply to include our new store hours."}

レスポンス

200Edit accepted and queued for re-submission. `data.editResponse` returns the identifiers.
Response
{  "data": {    "editResponse": {      "status": "true",      "reviewId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",      "responseId": "2090753a-ece6-4837-8336-8494ad308523"    }  }}
401Unauthenticated, missing or invalid API key.

既存のオーナーの返信内容を更新します。編集された返信は元のプラットフォームに非同期で再送信され、そのinteractionStatusはCREATEDに戻り、プラットフォームが更新を確認するとCOMPLETEDまたはCONFIRMEDに遷移します(返信のステータス遷移を参照)。

reviewId(インタラクション)とresponseId(特定の返信)の両方が必要です。IDによるインタラクションの取得またはインタラクションの一覧取得を使用して、インタラクションのresponses[].idからresponseIdを取得します。

ユースケース:公開中の返信の誤字を修正する

公開済みのオーナーの返信に誤りがある場合は、アーカイブして再投稿するのではなく、既存の返信を編集することで、レビューごとに1件の返信しか許可しないプラットフォーム(Googleなど)でも返信を保持できます。インタラクションのresponses配列を確認し、修正する返信のidを取得して、POSTを実行します。

JSON
{  "reviewId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",  "responseId": "2090753a-ece6-4837-8336-8494ad308523",  "responseContent": "Thank you again: we've updated our reply to include our new store hours."}

statusが"true"の場合、編集は受け付けられています。IDによるインタラクションの取得をポーリングして、更新された返信が元のサイトでCONFIRMEDになったことを確認してください。

Request
curl -X POST 'https://listingsapi.com/api/v4/locations/reviews/respond/edit' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "reviewId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",    "responseId": "2090753a-ece6-4837-8336-8494ad308523",    "responseContent": "Thank you again: we've updated our reply to include our new store hours."  }'