POSTapi.synup.com/api/v4/locations/photos/remove
Delete Location Photos
This API allows you to delete one or more photos of type ADDITIONAL from a specified location.
For more details, refer to Manage photos for your location.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Body
| Name | Type | Required | Description |
|---|---|---|---|
input | object | required | |
input.locationId | string | required | ID of the location to remove photos from |
input.photoIds | array of string | required | List of Photo IDs to be deleted |
Request
Request
curl -X POST 'https://api.synup.com/api/v4/locations/photos/remove' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '""'const res = await fetch('https://api.synup.com/api/v4/locations/photos/remove', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify(""),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/locations/photos/remove",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json="",
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/photos/remove", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Logo/Cover Cannot Be Starred: If a request includes photos of type LOGO or COVER, the operation will fail for those photos. |
Example response (generated from the schema)
{
"data": {
"removeLocationPhotos": {
"success": true,
"errors": null,
"photos": [
{
"databaseId": 0,
"fileSize": 0,
"id": "string",
"name": "string",
"starred": true,
"thumbnailUrl": "string",
"type": "string",
"url": "string",
"publisherOverride": "string"
}
],
"clientMutationId": null
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.removeLocationPhotos | object | required | |
data.removeLocationPhotos.success | boolean | required | |
data.removeLocationPhotos.errors | null | required | |
data.removeLocationPhotos.photos | array of object | required | |
data.removeLocationPhotos.photos[].databaseId | integer | optional | |
data.removeLocationPhotos.photos[].fileSize | integer | optional | |
data.removeLocationPhotos.photos[].id | string | optional | |
data.removeLocationPhotos.photos[].name | string | optional | |
data.removeLocationPhotos.photos[].starred | boolean | optional | |
data.removeLocationPhotos.photos[].thumbnailUrl | string | optional | |
data.removeLocationPhotos.photos[].type | string | optional | |
data.removeLocationPhotos.photos[].url | string | optional | |
data.removeLocationPhotos.photos[].publisherOverride | string | optional | |
data.removeLocationPhotos.clientMutationId | null | required |