Listings APIListings API
Entrar
POST/api/v4/locations/reviews/respond/archive

Arquivar uma resposta

Arquiva uma resposta existente do proprietário, removendo-a das respostas ativas monitoradas para uma interação.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
responseIdstringobrigatórioID of the response to archive (the `id` from an interaction's `responses` array).

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

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

Respostas

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

Arquiva uma resposta publicada anteriormente em uma interação. O arquivamento é uma exclusão lógica do cache local da Listings API: ele remove a resposta de responses monitorado para a interação, mas não a retira da plataforma de origem. As respostas já publicadas no Google, Yelp ou Facebook permanecem disponíveis nessas plataformas.

Obtenha responseId de responses[].id de uma interação por meio de Obter interações por IDs ou Listar interações.

Caso de uso: remover um rascunho de resposta substituído

Se uma resposta foi criada por engano ou substituída antes de ser publicada, arquive-a para manter a lista responses da interação organizada e o indicador responded correto no seu painel:

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

Para alterar o texto de uma resposta que já foi publicada no site de origem, use Editar uma resposta; o arquivamento não a removerá da plataforma de publicação.

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"  }'
Run in playground