POST/api/v4/locations/photos/remove

从地点移除照片

根据媒体 ID 解除一个或多个媒体文件与地点的关联。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

请求体

名称类型必填描述
input.locationIdstring必填The location's Base64-encoded Relay ID the photos belong to.
input.photoIdsarray of strings必填Media file IDs to detach from the location (as returned by the get-photos or upload endpoints).

请求示例

可直接粘贴的请求体。请将占位 ID 和值替换为您自己的。

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

响应

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.

解除媒体与地点的关联。通过 photoIds(get-photos 或上传端点返回的 ID)指定要移除的文件。响应中的 removedCount 表示实际解除关联的文件数,可用来发现已被移除的 ID。

使用场景:移除过时的店面图片。 门店翻新后,列出该地点的照片,选出过时的附加图片,并通过 photoIds 传入其 ID,即可在一次调用中将这些图片从各发布平台下架。

使用场景:撤销错误的批量上传。 如果自动导入关联了错误的素材,请从上传响应中收集这些错误素材的媒体 ID 并立即移除,然后重新上传正确的文件。

注意事项。

  • 只有 ADDITIONAL 类别的照片可以通过 API 移除。LOGO 和 COVER 图片无法在此删除,请通过上传端点替换这些图片。
  • 移除媒体会解除其与地点的关联;这不一定会从账户媒体库中彻底删除该文件。
  • 当 removedCount 为 0 且 errors: null 时,表示所提供的所有 ID 均未与该地点关联。
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="      ]    }  }'