Listings APIListings API
Se connecter
POST/api/v4/locations/photos/remove

Retirer des photos d'un établissement

Dissocie un ou plusieurs fichiers multimédias d'un établissement à l'aide de leurs identifiants de média.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Corps

NomTypeObligatoireDescription
input.locationIdstringobligatoireThe location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of stringsobligatoireMedia file IDs to detach from the location (as returned by the get-photos or upload endpoints).

Exemple de requête

Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.

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

Réponses

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.

Dissocie des médias d'un établissement. Identifiez les fichiers à retirer à l'aide de photoIds (les identifiants renvoyés par les endpoints get-photos ou de téléversement). Le champ removedCount de la réponse vous indique combien de fichiers ont effectivement été dissociés, ce qui vous permet de repérer les identifiants qui n'étaient déjà plus associés.

Cas d'utilisation : retirer des images obsolètes de la devanture. Après des travaux de rénovation, récupérez la liste des photos de l'établissement, sélectionnez les images supplémentaires obsolètes et transmettez leurs identifiants dans photoIds pour les retirer des plateformes de publication en un seul appel.

Cas d'utilisation : annuler un téléversement en masse incorrect. Si un import automatisé a associé les mauvais médias, récupérez les identifiants des médias concernés dans la réponse du téléversement et retirez-les immédiatement, puis téléversez à nouveau les bons fichiers.

Points de vigilance.

  • Seules les photos de la catégorie ADDITIONAL peuvent être retirées via l'API. Les images LOGO et COVER ne peuvent pas être supprimées ici ; remplacez-les plutôt via l'endpoint de téléversement.
  • Le retrait d'un média le dissocie de l'établissement ; il ne supprime pas nécessairement le fichier de la bibliothèque multimédia du compte.
  • Une valeur de 0 pour removedCount avec errors: null signifie qu'aucun des identifiants fournis n'était associé à cet établissement.
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="      ]    }  }'
Run in playground