Star/Unstar Location Photos

POST

https://api.synup.com/api/v4/locations/photos/star

This API allows you to star or unstar photo(s) for a specific location. A starred photo highlights its importance and increases its visibility in certain displays.

A location can have a maximum of 4 starred images. Attempting to star additional photos will result in an error.
Only additional photo types can be starred or unstarred. The logo and cover image cannot be starred.

For more details, refer to Manage photos for your location.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "locationId": "TG9jYXRpb246MTA4NzIxMQ==",
        "photoIds": [
            "TWVkaWFGaWxlOjU2MzgyMDU="
        ],
        "starred": true
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synup.com/api/v4/locations/photos/star' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": {
        "locationId": "TG9jYXRpb246MTA4NzIxMQ==",
        "photoIds": [
            "TWVkaWFGaWxlOjU2MzgyMDU="
        ],
        "starred": true
    }
}'

Responses

🟢200OK

application/json

The response will provide details of the photos that were processed, whether successfully starred or unstarred. If any errors occur, the response will include error information.

Body

Examples

SuccessException

{
    "data": {
        "starUnstarLocationPhotos": {
            "success": true,
            "error": null,
            "photos": [
                {
                    "databaseId": 5638205,
                    "fileSize": 95636,
                    "id": "TWVkaWFGaWxlOjU2MzgyMDU=",
                    "name": "090f5748-2f84-405e-bd04-6cd42dad2496",
                    "starred": true,
                    "thumbnailUrl": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_7c7fdefb-c50d-4478-8b8e-957011444445.jpg",
                    "type": "ADDITIONAL",
                    "url": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/7c7fdefb-c50d-4478-8b8e-957011444445.jpg",
                    "publisherOverride": ""
                }
            ]
        }
    }
}

Modified at 2025-07-15 14:02:51

Check Bulk Photo Upload Status

Delete Location Photos