POST/api/v4/locations/photos/remove

Remover fotos de um local

Desvincula um ou mais arquivos de mídia de um local pelos IDs de mídia.

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
input.locationIdstringobrigatórioThe location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of stringsobrigatórioMedia file IDs to detach from the location (as returned by the get-photos or upload endpoints).

Exemplo de requisição

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

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "photoIds": [      "TWVkaWFGaWxlOjU4Nzg5MzI="    ]  }}

Respostas

200Photos removed. `removedCount` reports how many media files were detached.
Response
{  "data": {    "removeLocationPhotos": {      "clientMutationId": null,      "removedCount": 1,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.

Desvincula mídias de um local. Identifique os arquivos a remover por photoIds (os IDs retornados pelos endpoints get-photos ou de upload). O campo removedCount da resposta informa quantos arquivos foram efetivamente desvinculados, o que permite detectar IDs que já não estavam vinculados.

Caso de uso: retirar imagens desatualizadas da fachada. Após uma reforma, liste as fotos do local, selecione as imagens adicionais desatualizadas e passe seus IDs em photoIds para removê-las das plataformas de publicação em uma única chamada.

Caso de uso: desfazer um upload em massa incorreto. Se uma importação automatizada vinculou os arquivos errados, reúna os IDs dessas mídias a partir da resposta do upload e remova-as imediatamente; em seguida, faça o upload dos arquivos corretos.

Pontos de atenção.

  • Somente fotos da categoria ADDITIONAL podem ser removidas pela API. As imagens LOGO e COVER não podem ser excluídas aqui; substitua-as pelo endpoint de upload.
  • A remoção de uma mídia a desvincula do local; ela não necessariamente exclui o arquivo da biblioteca de mídia da conta.
  • Um valor de 0 em removedCount com errors: null significa que nenhum dos IDs fornecidos estava vinculado àquele local.
Request
curl -X POST 'https://listingsapi.com/api/v4/locations/photos/remove' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "photoIds": [        "TWVkaWFGaWxlOjU4Nzg5MzI="      ]    }  }'